API references

SmartFace Platform provides you multiple API endpoints for accessing the data and configuration of the server. There are three types of the API available: REST API, OData API and GraphQL API.

SmartFace REST API#

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.

Open API specification for REST API is accessible through the URL: http://<your_server_name>:8098/swagger/v1/swagger.json

To quickly call available endpoints you can use a Swagger interface accessible through the URL: http://<your_server_name>:8098/index.html

The HTML documentation for the REST API is available here.

SmartFace OData API#

SmartFace OData API is by default available on port 8099. It allows you to query complex SmartFace Platform data.

Open API specification for OData API is accessible through the URL: http://<your_server_name>:8099/swagger/v1/swagger.json

To quickly call available endpoints you can use a Swagger interface accessible through the URL: http://<your_server_name>:8099/index.html

SmartFace GraphQL API#

SmartFace provides GraphQL API for powerful data querying. SmartFace GraphQL server is by default available on port 8097.

GraphQL server listens for requests at endpoint: http://<your_server_name>:8097/graphql

GraphQL schema can be downloaded through the URL: http://<your_server_name>:8097/graphql?sdl

To quickly browse the GraphQL schema and create GraphQL requests, use the built-in Web IDE by opening the GraphQL endpoint (http://<your_server_name>:8097/graphql/) in the browser.

GraphQL provides subscriptions as a built-in mechanism for consuming realizing notifications. More information about provided notifications can be found in the notifications documentation

For more information about GraphQL language, follow this link