Generate an API key
This endpoint is used to generate an API key for a given user. This API key is for the Application User it is assigned for only, and only for your API.
Request
An API key is a token that you provide when making API calls.
An Application ID that finds the application you are working with. This Application ID can be found on the Integral platform through the dashboard or Application’s page.
Body Parameters
This is a unique index on your database to find users. This will allow us to know which API key associates to each user on your application’s end.
This is the name applied to allow it to be indexed.
This is the description applied to an API key to identify it for a human. Use this to describe who the key belongs to, or why this key is relevant/exists.
This value is a boolean to determine whether the key is for Sandbox use only or not. If it is for sandbox use, it will not be able to access real data and will only be able to work with templated data.
When the old key (passed in key) will expire and become revoked (only previous
requests and logs are visible). Options are: - 1h
: in 1 hour - 24h
: in 24
hours - 3d
: in 3 days - 7d
: in 7 days - 2w
: 2 weeks
Attach metadata to help with indexing on a user, or for easily pulling data off of on the request.