Overview
Partners and agent integrations require authentication to access platform resources. This guide covers API key setup and customer account discovery for multi-account management.API Key Setup
All API requests require an API key in theAuthorization
header:
API Key Security:
- Get your Scope3 API key: Get one here
- Use HTTPS only - never send keys over HTTP
- Store keys securely and rotate regularly
- Provider API keys provide access to specific customer accounts based on your partner configuration
Discovering Manageable Customer Accounts
Check Customer Access
MCP Tool:signals/get-partner-seats
Use this tool to discover which customer accounts your provider API key can manage data for:
- Customer account ID and display name
- Seat identifier for API operations
- Access granted through provider-customer relationships
- Management permissions scope
Using Customer Account Information
Once you know which customer accounts you can manage, you can: Filter operations by customer account:- Customer signals and segments
- Campaign configurations
- Performance data access
- Account-level settings
Authentication Scopes
Partner API keys provide different access levels:Read Access
- List accessible seats
- View segments and signals
- Read campaign performance data
- Access reporting APIs
Write Access
- Create and update segments
- Attach data to segments
- Register signals agents
- Modify campaign configurations
Administrative Access
- Manage API key permissions
- Configure seat access controls
- Set up webhook endpoints
- Access audit logs
Multi-Customer Operations
When working across multiple customer accounts, operations automatically scope to your manageable accounts: List all segments across customer accounts:seatId
- Unique seat identifier for API operationsseatName
- Customer account display namecustomerId
- Internal customer account ID- Standard resource metadata
Error Handling
Common authentication errors:Invalid API Key
Insufficient Permissions
Customer Account Not Found
Sales Agent & Signals Agent Authentication
Sales agents and signals agents support multiple authentication mechanisms for secure communication with publisher endpoints. This section covers how to register agents with authentication and the approval process for live inventory access.Supported Authentication Types
The platform supports four authentication mechanisms for agent integrations:Bearer Token Authentication
Simple token-based authentication using HTTP Authorization headers. Configuration Example:OAuth 2.0 Authentication
Automatic OAuth 2.0 authentication using publisher discovery and client registration. Configuration Example:- Discovers OAuth endpoints via
.well-known
protocols - Registers Scope3 as an authorized client with the publisher
- Manages token refresh and caching
Automatic OAuth Setup: Scope3 handles all OAuth client registration and credential management. You only need to provide the publisher’s OAuth issuer domain.
Custom Headers Authentication
Custom header-based authentication (e.g., API keys in custom headers). Configuration Example:Custom Integrations
Scope3 can build custom authentication integrations for specific publishers with unique authentication requirements.Custom Integration Development:
For publishers requiring specialized authentication flows (like proprietary JWT schemes), contact Scope3 to discuss custom integration development. These integrations are built on a case-by-case basis.
Registration Process
For Sales Agents
Use thesales_agents_register
tool with authentication configuration:
For Signals Agents
Use thesignals_agent_register
tool with optional authentication in config:
Business Approval Required:
All sales agents added by customers require Scope3 testing and approval before accessing live inventory. This ensures:
- Technical compatibility with publisher endpoints
- Authentication security validation
- Compliance with platform standards
- Quality assurance for production use