API Description

In order to use the VoC authentication API you must have a valid environment specific username and password. All API requests must be made over HTTPS.

API Endpoints

Request example

curl -X POST "https://api.confidently.fi/api/responses/test/v2/auth" -d "u=<USERNAME>" -d "p=<PASSWORD>"

Response example

Successful request - http status code 200

If you have a valid username and password the request will be successful.

{
  "api-key": "ABCDEF1234567890"
}

Failed request - http status code 401

If you don't have a valid username and password, or the user credentials are misspelled.

{}

How to use the API KEY

The API KEY parameter must be sent in the request authorization header element. If the API KEY value is valid then API request will be successful (http status code 200), otherwise it will fail (http status code 401).

curl -X GET "https://api.confidently.fi/api/responses/test/v2/company" -H "Authorization: x-api-key {APIKEY}"