Integration Guide

Prerequisites

• An active SymphonyOS partnership agreement
• A dedicated brand account in SymphonyOS
• Technical contact for API key provisioning

Getting Started

Step 1: Request API Access

Contact the SymphonyOS partnerships team at [email protected] with:

• Company name and use case description
• Expected API volume (requests per month)
• Technical contact email

Step 2: Receive API Credentials

Once approved, you'll receive:

• API Key – Used in the Authorization header
• Brand ID – Your organization identifier in SymphonyOS
• API Base URL – https://api.symphonyos.co/v2
• Documentation Access – Link to this documentation

Step 3: Authentication

All API requests require an API key passed in the Authorization header:

Authorization: Bearer YOUR_API_KEY_HERE

Step 4: Test Connection

Verify your credentials with the API test endpoint:

curl -X GET https://api.symphonyos.co/v2/sym/v2/api-test \
  -H "Authorization: Bearer YOUR_API_KEY_HERE"

Step 5: Rate Limits & Best Practices

• Rate Limit: 1,000 requests per hour (adjustable for enterprise partners)
• Caching: Streaming links are cached for 5 minutes; you may cache on your end for up to 24 hours
• Error Handling: All endpoints return standard HTTP status codes with descriptive error messages
• Webhooks: Register webhook endpoints to receive real-time notifications (website published, leads captured, etc.)