🔑API keys

Keys are used to interact with TurinPay. Keys are used for autnetication purposes to identify the request source of the call.

Issue an API key

POST https://api.turinpay.com/users/keys

Headers

Name	Type	Description
X-API-Key	string	Authentication token from the API key belonging to the user

Request Body

Name	Type	Description
role	string	Token role with permissions. Invoices role by default

200

{
    "key": "9759dd17-357a-4a81-a25a-0ced7fa6e61e",
    "userId": "f357abeb-b4c7-43ac-afd8-f76067c829ab",
    "role": "invoices"
}

Retrieve an API key

GET https://api.turinpay.com/users/:key

Path Parameters

Name	Type	Description
key	string	API key

Headers

Name	Type	Description
X-API-Key	string	Authentication token from the API key belonging to the user

200

{
    "key": "9759dd17-357a-4a81-a25a-0ced7fa6e61e",
    "userId": "f357abeb-b4c7-43ac-afd8-f76067c829ab",
    "role": "invoices"
}

List API keys

GET https://api.turinpay.com/users/keys

Headers

Name	Type	Description
X-API-Key	string	Authentication token from the API key belonging to the user

200

{
    "key": "f823396c-ab01-4179-b138-e1e538cd49e5",
    "userId": "f357abeb-b4c7-43ac-afd8-f76067c829ab",
    "role": "invoices"
},
{
    "key": "0354b6a0-d1a6-449e-a8be-36773bdfb99e",
    "userId": "f357abeb-b4c7-43ac-afd8-f76067c829ab",
    "role": "invoices"
}

Remove API key

DELETE https://api.turinpay.com/keys/:key

Path Parameters

Name	Type	Description
key	string	API key

Headers

Name	Type	Description
X-API-Key	string	Authentication token from the API belonging to the user

200

{
    "success": true
}