General information #

This page documents about:

• Json Web Tokens
• Scopes
• Test environment
• Quotas of requests

Json Web Token #

You must add a Json Web Token (JWT) in a Bearer Authorization header for all your requests, since every endpoint is protected.

Generate the JWT with our API #

Easy and secure, our API has an endpoint for generating a JWT from your private key and the secret encryption key. Check the documentation.

Our team sent you these two keys by email. Your private key is unique, identifies your requests and gives you the proper access to the account's data. You should not share it.

Generate the JWT yourself (optionnal) #

Here are the necessary attributes for identification and validation:

In the header:

• The signing algorithm alg being used is "HS256"
• The type of the token typ , which is "JWT"

In the payload:

• Your private key, as JWT attribute iss
• The audience, as JWT attribute aud (you can read more about it in the environments section below)
• The token creation date, as JWT attribute iat
• The token expiration date, as JWT attribute exp (optionnal)

Scopes #

The endpoints of the Kelio ATS API are protected with scopes.

The different scopes are:

applicants_write, applications_read, applications_write, campaigns_read

Environments #

The Kelio ATS API is powerful and have impact on people. For instance, it can send email to applicants when you create them. Therefore the sandbox environment should be used when learning to use our API.

In production:

• The API base url is: https://api.talentview.fr/v2
• The JWT audience field is: https://api.talentview.fr

In sandbox:

• The API base url becomes: https://sandbox.talentview.fr/v2
• The JWT audience field becomes: https://sandbox.talentview.fr

Quota #

A quota of 120 requests per minute is setup.

If the quota is reached, the API will reply with a 403 error.

Postman #

Some of our documentation is hosted on Postman. That workspace will:

• give examples of responses
• allow to fork and experiment

For those unfamiliar with postman, here are useful resources, in video and written.