To proceed with the authentication process, you will need API keys directly from the Veritus Agent Platform.
Protecting your API keys
It is essential to prioritize the security of your API keys, as they grant access to make various API calls on behalf of your account. To ensure the safety of your keys, we recommend following these best practices:
Limit access
Grant API key access only to individuals who require it for their designated tasks. Restricting access helps minimize the risk of unauthorized usage or accidental exposure.
Avoid version control
Avoid storing your API keys in any version control system. This prevents the keys from being inadvertently shared or compromised through code repositories.
Secure access control
Implement robust access control measures for your API keys. Utilize password managers or secrets management services to securely store and manage the keys. This ensures that only authorized individuals can access and utilize them.
Avoid embedded keys
It is crucial to refrain from embedding your secret API keys within mobile applications or any other vulnerable locations where the keys could be easily extracted. Embedding keys in such places increases the risk of unauthorized access and misuse.
By adhering to these best practices, you can maintain the integrity and security of your API keys, reducing the likelihood of unauthorized access and potential misuse.
Authentication with bearer tokens
The Veritus Agent Platform API utilizes Bearer Token authentication for authenticating your API requests.
Every API endpoint that requires authentication expects an authorization HTTP header with a static Bearer token as its value.
curl -i -X GET https://{veritus-agent-platform-url}
-H 'Authorization: Bearer sk-0919f74f0ce05250aa5cb9409c42f6e8e4b982df8019eaf792934f3f25ed488b'
-H 'Content-Type: application/json'
The secret key will be provided, and it will not be possible to regenerate the
key. If the secret key is compromised or lost, you will need to generate a new
key.
