Authorization

API Authentication with Bearer Tokens

This document outlines the authentication process for accessing the API using Bearer Tokens. All API requests require a valid Client Key with the appropriate permissions to access the desired Data View.

Authentication Method: Bearer Token

The API utilizes a Bearer Token authentication scheme, offering a simple and secure method for verifying your identity and permissions.

How it Works

1. Client Key & Data View: You’ll need an active Client Key that has been granted permission to access a specific Data View within the API. The Data View defines the data being retrieved. The Client Key can further restrict this scope.
2. Bearer Token Generation: The bearer token is generated when a Client Key is first generated.
3. Request Header: You include this Bearer Token in the Authorization header of your API requests.

Key Considerations:

• Client Key Security: Client Key security levels vary based on the data they access. Keys with permissions to ingest data into Data Pools and access non-public data require strict security protocols and controlled access. In contrast, Client Keys authorized to retrieve public data from views can typically be used within client-side applications, although secure storage practices should still be followed.”
• Data View Permissions: Ensure your Client Key has the correct permissions to access the specified Data View. If you attempt to access a Data View you haven't been granted access to, the API will return an authorization error.

Troubleshooting:

• 401 Unauthorized: This error typically indicates that the provided Client Key is invalid, expired, or does not have the necessary permissions for the requested Data View. Double-check your Client Key and ensure it’s granted the correct Data View access.
• 403 Forbidden: While less common, this could indicate a problem with your Client Key's permissions, even if the key is valid. Contact your administrator to verify.

Examples

Curl

The following is a simple example making a terminal based request with curl.

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>"
  ttps://visagedata.com/egress/<data_view_id>

Further Information

For more detailed information on obtaining Client Keys and managing Data View permissions, please refer to Client Keys and Data Views.