Konvert API
The KONVERT API is a GraphQL API which allows many extendibility options to portal customers.
Endpoints
All requests are completed over the same endpoint using POST.
Production API URL: https://api.konvertapp.com/api
Staging API URL: https://api.staging.konvertapp.com/api
*The staging environment can have different data and configuration than production. Not all portal clients are setup on staging automatically, Do not use this environment unless you are instructed to do so. If you have a need for a KONVERT staging environment, please reach out to support.
Authentication
You will be given an API Key and Secret Key pair. These are used to generate a JWT token which can be used to query the KONVERT API.
Use a JWT library (https://jwt.io/) to generate the token using the “sign” function:
token = jwt.sign( {sub: apiKey} , apiSecretKey , { expiresIn: 3600 });
expiresIn is the number of seconds the token should be valid for. Must not be greater than 6 hours (21600 seconds).
The token is then provided as a Bearer token in the Authentication header:
Authorization = Bearer [token]
This authorization header will need to be present in all calls to the API.
Field Specific Documentation
The KONVERT API can be explored from a tool like the Apollo Studio:
Enter the Authorization header in the HTTP Headers area.