Get started with Konvex
The Konvex API employs a straightforward authentication method, utilizing a specific header obtained through registration on our web application. Each request is required to include the X-Secret` header, comprising the user ID and the secret key.
Acquiring Access Data:
To obtain access data, please proceed with the following steps:
- If you haven't registered in our application yet, please sign up for konvex
- Navigate to the setup side menu and access the API keys link. There, you'll find the client_id and secret_key.
Change Credentials
You can modify your secret key at any time, although it remains crucial for the proper functioning of your requests.
How to use access data?
For each request, include the X-Secret header, compose this header by combining your client_idfollowed by a colon and then your secret_key.
The header format should appear as follows:
Important: This x-secret is only functional in requests made in sandbox
x-secret: 76a33cc5-c8c5-474c-86a4-6d5a1d715ce6:b3d66c8ae48ffcb685d521cc3f4c198d62652086a8859f72b8c2437582b47b510c9ff8bc243625fca2f3e6a11a87a587
Authentication errors
If authentication issues are detected by the API, it will return a 401 status code along with the specific error encountered.