API

SmartFace Platform provides you API endpoints for accessing the data and configuration of the server. There are two types of the API available: REST API, GraphQL API There is also a third, legacy and deprecated type called OData API

SmartFace REST API#

The SmartFace REST API is by default available on port 8098. It allows you to configure or perform basic queries in a simpler and more user-friendly way. For more information please visit the REST API in the integration section.

The HTML documentation for the REST API is available here.

SmartFace GraphQL API#

SmartFace provides GraphQL API for powerful data querying and subscriptions as a built-in mechanism for consuming realizing notifications. SmartFace GraphQL server is by default available on port 8097.

For more information please visit the GraphQL API in the integration section.