Peaka Partner API
The Peaka Partner API is a powerful gateway that lets you seamlessly integrate Peaka's features into your own applications and services. With secure access provided through a unique API key, you can leverage the full potential of Peaka's capabilities to enhance your user experience and streamline operations.
Key Features
- Secure Authentication: Access the API with confidence using the apiKey provided by Peaka, ensuring secure and authorized interactions.
- Robust Functionality: Utilize a wide range of functions, from data retrieval to executing complex operations, all tailored to meet diverse integration needs.
- Real-Time Data Access: Retrieve up-to-the-minute information to keep your services synchronized with the latest developments within Peaka.
- Customizable Integration: Tailor the API's extensive features to fit your platform's specific requirements, providing a personalized experience for your users.
- Scalability: Designed to handle requests at scale, the Peaka Partner API can accommodate growing traffic as your business expands.
- Dedicated Support: Benefit from Peaka's dedicated support for API integration and usage.
Getting Started
- API Key Activation: Create your unique apiKey from the Developer section in Peaka Studio. This key is essential for all API requests.
- Pick your zone: The API is served from US and EU zones — see Servers for base URLs and guidance.
- Authenticate: Send the key as a Bearer token — see Authentication.
Support and Assistance
Our dedicated team is available to assist you throughout the integration process and beyond. Should you have any questions or require technical support, please reach out through the Peaka Community or email support@peaka.com.
Servers
The Peaka API is hosted in two geographic zones to ensure optimal performance, compliance, and data residency for users worldwide. Each zone has its own server endpoint, allowing you to choose the one that best suits your location, regulatory requirements, and latency needs.
- US Zone:
https://partner.peaka.studio/api/v1
- EU Zone:
https://eu.partner.peaka.studio/api/v1
Choosing the Right Zone
Geographic Proximity
- Use the US Zone if your operations or users are primarily based in North America. This reduces latency and improves performance for users in that region.
- Use the EU Zone if your operations or users are primarily based in Europe or if you need to comply with EU data protection regulations, such as GDPR.
Compliance and Data Residency
- The EU zone is designed to meet strict data residency and privacy requirements, making it ideal for organizations operating under European regulations.
- The US zone is optimized for users in North America but may also be suitable for global operations outside the EU, depending on your compliance needs.
API Functionality
Both zones offer identical API functionality, endpoints, and features. The only difference is the geographic location of the servers and the domain used to access them.
Making API Requests
Include the appropriate base URL (depending on your chosen zone) in your API requests. For example:
# US-based request
GET https://partner.peaka.studio/api/v1/supportedDrivers
# EU-based request
GET https://eu.partner.peaka.studio/api/v1/supportedDrivers
Ensure that your API key is included in the request headers as described in the Authentication section.
Authentication
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.
- Project API Key: Grants access to resources specific to the project for which the key was created.
While Project API Keys are restricted to project-specific resources, Partner API Keys provide broader access across all available resources. Badges next to endpoint descriptions indicate which type of API key can be used.
Using your key
Include the API key in the Authorization header as a Bearer token:
Authorization: Bearer <API Key>
Example: Using a Partner API Key
A Partner API Key can perform all actions a Project API Key can, plus partner-level operations. For example, to list all organizations accessible by the partner:
GET api/v1/organizations
Authorization: Bearer <Partner API Key>
You can also use a Partner API Key on project-scoped endpoints:
GET api/v1/data/projects/{projectId}/catalogs
Authorization: Bearer <Partner API Key>
Example: Using a Project API Key
Project keys work on endpoints scoped to their project — whenever you see projects/{projectId} in a path, it is project-scoped:
GET api/v1/data/projects/{projectId}/catalogs
Authorization: Bearer <Project API Key>
Replace {projectId} with the ID of your project.
Structure
Peaka provides a structured environment for managing data integrations and analytics. Understanding the hierarchy and relationships between its core components is essential for effective utilization.
🔹 Organization
- Definition: The top-level entity representing a business or team within Peaka.
- Role: Serves as the container for all workspaces, projects, and associated resources.
- API Endpoint:
GET /organizations to list all organizations.
🔹 Workspace
- Definition: A collaborative environment within an organization where teams can manage projects.
- Role: Facilitates team collaboration and resource management within an organization.
- API Endpoint:
GET /organizations/{organizationId}/workspaces to list workspaces within an organization.
🔹 Project
- Definition: A unit within a workspace where data connections are established and workflows are executed. This is the core component of Peaka. Projects are isolated from other projects within the same workspace. You can create Project API Keys to enable access to only this project.
- Role: Central unit for data operations, including queries, tables, and integrations.
- API Endpoint:
POST /organizations/{organizationId}/workspaces/{workspaceId}/projects to create a new project.
🔹 Connection
- Definition: A configuration that links a project to external data sources, such as databases or APIs, including necessary credentials.
- Role: Holds the necessary details for connecting to external data sources.
- API Endpoint:
POST /projects/{projectId}/connections to establish a new connection.
- Note: A single connection can be used to create multiple catalogs, allowing credential reuse across catalogs of the same external data source.
🔹 Catalog
- Definition: A structured representation of data schemas and tables associated with a connection.
- Role: Provides metadata and structure for querying and analyzing data.
- API Endpoint:
POST /projects/{projectId}/catalogs to create a catalog using a connection.
- Note: Multiple catalogs can be created from a single connection, each representing different naming of the same external source.
