Authentication
API Authentication
Overview
The Peaka Partner API uses API keys for authentication.
There are two types of API keys:
- Partner API Key: Grants access to all resources for partner-level access. Learn how to manage a Partner API Key
- Project API Key: Grants access to resources specific to the project for which the key was created. Learn how to generate API Keys
While Project API Keys are restricted to project-specific resources, Partner API Keys provide broader access across all available resources.
Authentication
To authenticate requests, include the API key in the Authorization
header as a Bearer token. The format is as follows:
This ensures secure authentication for API requests, with access based on the type of API key used.
Example: Using a Partner API Key
A Partner API Key can perform all actions that a Project API Key can, plus additional partner-level operations. For example, to list all organizations accessible by the partner:
This returns all organizations and related resources the partner has access to.
You can also use a Partner API Key to access endpoints scoped to a specific project. For example, to list catalogs within a project:
This returns data catalogs associated only with that project.
Example: Using a Project API Key
You can use a Project API Key to access endpoints scoped to a specific project. (Whenever you see projects/{projectId}
in the path of an endpoint, it is scoped to the project.)
For example, to list catalogs within a project:
Replace {projectId}
with the ID of your project.
This returns data catalogs associated only with that project.