GraphQL API

Our full GraphQL Schema can be viewed here - https://developers-v2.custom-gateway.net/graphql/index.html

Our GraphQL API is a very powerful tool for doing a massive amount of functions within the platform. To the left is a list of common functions but should not be treated as an exhaustive list.

Authentication

The GraphQL API uses oauth authentication. A request for an oauth token is made to the oauth endpoint, which returns an access token. This token can then be used in requests made to the GraphQL API endpoint.

To make a request for a token, you will require an oauth user to be set up in the Kornit^X platform. The user will require specific access and permissions depending on the API request. The permissions required for this request can be found in the “Oauth User Requirements” section below.

If you don’t have an oauth user set up, please contact the support team, who will be happy to help. The support team will set up the oauth user in the Kornit^X platform for you and supply you with the oauth user client ID and client secret. These credentials can then be used to obtain a token from the oauth token endpoint.

Oauth Token Endpoint - https://oauth.kornitx.net/token

The oauth token can be obtained by making a POST to the above endpoint. The request type for the oauth token is x-www-form-urlencoded and must include the following form keys and values.

Key	Value
`client_id`	The client ID of the oauth user provided by the support team.
`client_secret`	The client secret of the oauth user provided by the support team.
`grant_type`	`client_credentials`
`scope`	`order-it.order-manager.view`

Example Response

CODE

{"token_type":"Bearer","expires_in":3600,"access_token":"..."}

Oauth User Requirements

To make the orders request to the GraphQL API, the oauth user must have:

Access to the company or companies that the orders relate to.
The order-it.order-manager.view user permission enabled.