COconekta
Api Keys

Create Api Key

Create a api key

post/api_keys

Request

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

X-Child-Company-Idstring

In the case of a holding company, the company id of the child company to which will process the request.

Request body

descriptionstring

A name or brief explanation of what this api key is used for

rolestring required

Example request

{
  "description": "online store",
  "role": "private"
}

Response

successful operation

authentication_tokenstring

It is occupied as a user when authenticated with basic authentication, with a blank password. This value will only appear once, in the request to create a new key. Copy and save it in a safe place.

activeboolean

Indicates if the api key is active

created_atinteger

Unix timestamp in seconds of when the api key was created

updated_atinteger

Unix timestamp in seconds of when the api key was last updated

deactivated_atinteger nullable

Unix timestamp in seconds of when the api key was deleted

last_used_atinteger nullable

Unix timestamp in seconds with the api key was used

descriptionstring

A name or brief explanation of what this api key is used for

idstring

Unique identifier of the api key

livemodeboolean

Indicates if the api key is in production

objectstring

Object name, value is 'api_key'

prefixstring

The first few characters of the authentication_token

rolestring

Indicates if the api key is private or public

Example response

{
  "authentication_token": "key_rpHzxufNgjFCdprEEFZRTKi",
  "active": true,
  "created_at": 1684167881,
  "updated_at": 1684167923,
  "description": "online store",
  "id": "64625cc9f3e02c00163f5e4d",
  "object": "api_key",
  "prefix": "key_rp",
  "role": "private"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.