Authentication¶
To access our services, the employer is required to register on our YIP web app using the provided invitation code. Once registered, the web app enables the generation and revocation of API keys, which serve as bearer tokens for Authorization in REST API requests.
Important Security Notice
It is of utmost importance to safeguard the API key at all times. If there is any suspicion of the API key being compromised or accessible by unauthorized parties, we urge you to promptly utilise the web app to revoke the existing API key and generate a new one. Alternatively, you may contact our support team for further assistance.
Sovereign API Bearer Token¶
The API Key is a secure access token issued by our web application to registered users, enabling them to make authorized API calls. To utilise the key, users must include it in the Authorization header of their API requests:
API Key Management¶
Our platform offers API key management tools, putting users in full control. Within YIP web application settings, users can create, modify or revoke their API keys. These generated keys remain active until revoked, and the secret key remains confidential, only accessible during the initial creation process. These API keys serve as distinct identifiers for users using the API.
Find below an example of how API keys are presented to end users within our web application:
| Name | Key | Created | Last Used | |
|---|---|---|---|---|
| Key Name 1 | A%......oiRcT2 | 19 July 2023 | 20 July 2023 | |
| Key Name 2 | Fs......ssXcg4 | 17 Mar 2023 | - | |
| Create New API Key |
With these features, you can confidently manage API access, ensuring security and control throughout your application.
Created: July 19, 2023