Service Limits + Best Practices

This document provides an overview of rate limiting policies and best practices for integrating with the NewRosetta API effectively and efficiently.

Rate Limit Policy

• Request Limit: 6000 requests per minute.
• Bursting: Allowed for short periods to handle spikes in traffic.

Error Handling for Rate Limits

If your application exceeds the rate limit, the API will respond with a rate limit error. Implement a backoff policy to handle these errors effectively. Details of the backoff policy are available on the Error Handling Page.

Best Practices

1. Monitor API Usage

• Use API monitoring tools to keep track of request counts.
• Ensure that your application does not exceed the rate limit to avoid errors.

2. Implement Backoff Policies

• When receiving a rate limit error:
  • Wait for the duration specified in the error response.
  • Retry the request after the wait period.
• Follow the backoff policy guidelines to prevent excessive retries.

3. Optimize Workflows

• Batch Requests: Although currently unsupported, batching workflows will be available soon to reduce the number of requests. Keep an eye on updates.
• Combine Operations: Minimize the number of individual requests by combining related operations where possible.

4. Leverage Webhooks

• Register webhooks to receive real-time updates and reduce the need for frequent polling.
• Webhooks provide immediate notifications, making your application more responsive and efficient.

5. Implement Caching

• Cache responses for non-dynamic data to minimize redundant requests.
• Use the cache duration suggested in the API responses.

Example Implementation

Monitoring API Usage

import requests

API_KEY = "your_api_key"
CLIENT_ID = "your_client_id"
API_ENDPOINT = "https://api.newrosetta.com/v1/resource"

headers = {
    "x-api-key": API_KEY,
    "x-client-id": CLIENT_ID
}

response = requests.get(API_ENDPOINT, headers=headers)
if response.status_code == 429:
    retry_after = response.headers.get("Retry-After")
    print(f"Rate limit exceeded. Retry after {retry_after} seconds.")

Webhook Integration

curl -X POST "https://api.newrosetta.com/v1/webhooks" \
-H "x-api-key: <API_KEY>" \
-H "x-client-id: <CLIENT_ID>" \
-H "Content-Type: application/json" \
-d '{ "destinationUrl": "https://yourapp.com/webhook", "active": true }'

Notes

1. Future Enhancements: Batching workflows will be supported soon, enabling more efficient API usage.
2. Custom Identity Providers: If you have your own identity provider, NewRosetta can integrate with its signals. In this case, only Lexicon AI verification endpoints will be utilized.