Authentication

To ensure secure communication between your application and the Niva API, all API requests must be authenticated using token-based authentication. Each request must include an authentication token in the request headers. This token is provided when you register and is unique to your account.

Obtaining an API Token

To obtain an API token:

Receive Your Token

Once created, you can use that token to authenticate your API requests.

Sending Authenticated Requests

To authenticate your API requests, include the apiKey header with the token in your HTTP request.

Header Format

apiKey: YOUR_API_TOKEN

Example Request

Here’s an example of how to include the authentication token in an HTTP request using curl:

Error Handling

If the API token is missing or invalid, the API will return an error response with an appropriate status code.

Common Error Responses

401 Unauthorized: This error occurs if the token is missing or invalid.

403 Forbidden: This error occurs if the token does not have the necessary permissions to access the requested resource.

Example Error Response

{
  "error": "Unauthorized",
  "message": "Invalid or missing authentication token."
}

Best Practices

Keep Your Token Secure: Do not expose your API token in public repositories, client-side code, or anywhere it might be accessed by unauthorized individuals.

Regenerate Tokens Periodically: Periodically regenerate your API tokens to minimize the risk of them being compromised.

Monitor API Usage: Regularly monitor your API usage and be alert for any unusual activity.

Conclusion

Authenticating your API requests is essential for secure and authorized access to the Niva API. If you have any questions or need further assistance, please contact our support team at support@niva.co.

Authentication

Obtaining an API Token#

Sending Authenticated Requests#

Header Format#

Example Request#

Error Handling#

Common Error Responses#

Example Error Response#

Best Practices#

Conclusion#