Screendragon API Usage Guidelines

API Integration Guidelines

Welcome to the Screendragon API Portal! This page outlines the essential guidelines and best practices for integrating with our APIs. Please read carefully to ensure a smooth and efficient integration experience.

Authentication & Access

To access our APIs, clients must first obtain authentication credentials.

How to Get Started:

1. Request Access: To enable API access for your organization, please contact your Screendragon Account Manager. 
2. Receive Credentials: 
   • You will receive a Client ID and Client Secret for OAuth 2.0 authentication along with relevant URLs depending upon Grant type.
   • You will receive API Key for Basic Authentication.

Sandbox Environment

We provide a sandbox environment for testing and development, available as the Screendragon staging site.

Best Practices

To ensure optimal performance and avoid service disruptions, please follow these guidelines:

Efficient API Usage

• Avoid Unnecessary Calls: Only call endpoints when needed. Avoid polling or excessive retries.
• Use Webhooks: Where available, use webhooks instead of polling for updates.
• Batch Requests: Use batch endpoints when available to reduce the number of API calls.

Rate Limiting

• Standard Limit: 1,000 requests per hour per client.
• Throttling: Exceeding limits will result in 429 Too Many Requests responses.

Data Updates

• Avoid Frequent Updates: Do not send frequent updates for the same resource unless necessary.

Prohibited Activities

To maintain system integrity, the following are strictly prohibited:

• Sending automated or scripted traffic without prior approval.
• Attempting to bypass authentication or rate limits.
• Using production credentials in the sandbox environment.
• Posting sensitive or personal data in test environments.

Support & Contact

If you have questions or need help, Please contact your Screendragon Account Manager.