Uscreen API Essential Guide

What type of API does Uscreen provide?

Based on the search results provided, Uscreen does not explicitly state what type of API they use. However, some characteristics suggest it may be a REST API:

1. The mention of endpoints (e.g., tokenized_url) is typical of REST APIs.
2. The API is used for accessing content and user data, which aligns well with REST's resource-based approach.
3. REST APIs are widely used for web and mobile applications, which fits Uscreen's video streaming platform model.
4. The authorization key mentioned is a common authentication method for REST APIs.

Without official confirmation, this is an educated guess based on the limited information provided in the search results.

Does the Uscreen API have webhooks?

Webhooks Availability

Yes, Uscreen does offer webhooks as part of their API functionality.

Types of Events Available

Uscreen provides webhooks for the following event types:

1. Subscription Assigned
2. User Updated
3. Recurring Payment Successful
4. Began to Play Video
5. Payment Method Updated
6. User Signed In
7. Access Cancelled
8. Paid Order
9. New User

Key Points to Consider

• Webhooks are available for Pro and Plus plan customers.
• Webhooks can be used to extend Zapier functionality by using "Webhooks by Zapier" as a trigger.
• Setting up webhooks may require developer assistance, as it's outside of Uscreen's support scope.
• Webhooks are on a lower-priority queue and may have up to a 10-minute delay.
• There are rate limits of 100 calls/minute for most endpoints, and 10 calls/5 minutes for the sessions endpoint.

Best Practices

1. Implement duplicate checking, as webhooks may sometimes trigger multiple times for the same event.
2. Respond to webhooks within 5 seconds with a 200 HTTP status code to acknowledge receipt.
3. Be aware of rate limits and adjust your implementation accordingly.
4. Consider scheduling a monthly task to backfill potentially missing data.

Setting Up Webhooks

To set up webhooks in Uscreen:

1. Navigate to the Settings tab and select Webhooks
2. Click New webhook
3. Fill in the Callback URL and choose an Event Type
4. Click Save to save changes

In summary, Uscreen offers a robust webhook system as part of their API, allowing developers to integrate Uscreen data with other platforms and automate various processes based on events occurring within the Uscreen system.

Rate Limits and other limitations

The Uscreen API has the following rate limits:

Rate Limits

1. General rate limit: 100 calls per minute [1]

2. Sessions endpoint rate limit: 10 calls per 5 minutes [1]

Key Points to Consider

• These rate limits apply to the Uscreen API for Plus customers [1].
• If you need higher rate limits, you can contact Uscreen to discuss your specific use case [1].
• Uscreen may be able to work with you to find alternative solutions if your needs exceed the current rate limits [1].

Best Practices

1. Monitor your API usage to ensure you stay within the rate limits.
2. Implement proper error handling in your code to deal with potential rate limit errors.
3. If you consistently need higher limits, reach out to Uscreen to discuss your requirements.
4. Consider using other data access methods provided by Uscreen, such as webhooks or Zapier integrations, if they better suit your needs [1].

Additional Information

While not directly related to the API rate limits, it's worth noting that Uscreen has implemented concurrent login limitations based on IP addresses:

• Up to five concurrent streams are allowed for each user account at any time (excluding OTT app sessions) [2].
• This limit is based on IP addresses rather than the number of devices associated with an account [2].
• If you need to adjust this limit, you can contact Uscreen support to request changes [2].

Remember that these rate limits and concurrent session limitations are designed to ensure fair usage of the platform and maintain service quality for all users.

Latest API Version

Based on the search results provided, there is no specific information about the most recent version of the Uscreen API. However, I can provide some relevant information about the Uscreen API:

API Availability and Access

The Uscreen API is available to Uscreen Plus customers. If you're not on the Plus plan, you can still reach out to the Uscreen team to ask about access. Your Customer Success Manager (CSM) can provide you with an authorization key to use the API.

API Features and Functionality

The Uscreen API allows users to access content and user data. While there's no mention of specific versions, the API provides various functionalities:

• It can be used to generate tokenized URLs for creating new sessions in Uscreen.
• The API can be used in conjunction with webhooks and Zapier for data integration.

Rate Limits

The Uscreen API has rate limits in place:

• 100 calls per minute
• 10 calls per 5 minutes for the sessions endpoint

If you need higher limits, you can contact Uscreen to discuss your specific requirements.

Additional Considerations

• The API documentation is available, but the search results don't provide a direct link to it.
• Uscreen offers integrations with various third-party services, which might complement API functionality.
• While not directly related to the API version, it's worth noting that Uscreen introduced a new sign-in experience with magic links in July 2024.

Key Points

1. The API is primarily available to Uscreen Plus customers.
2. Authorization is required to use the API.
3. Rate limits are in place to manage API usage.
4. Uscreen offers additional integration options beyond the API.

While the search results don't provide information about the most recent version of the Uscreen API, it's recommended to contact Uscreen support or your CSM for the most up-to-date information about API versions and capabilities.

How to get a Uscreen developer account and API Keys?

No Public API Access

• Uscreen does not provide public API documentation or a self-service developer portal for creating API integrations.

Limited API Access Options

• If you're not on the Plus plan, you would need to contact the Uscreen team directly to inquire about potential API access.
• Your Customer Success Manager (CSM) at Uscreen would be the one to provide an authorization key if API access is granted.

Requesting Access

If you want to pursue API access:

1. Upgrade to the Uscreen Plus plan if you haven't already.
2. Contact your Uscreen Customer Success Manager.
3. Explain your integration needs and request API access.
4. If approved, they will provide you with an authorization key for API use.

Best Practices

• Be prepared to explain your specific use case and integration requirements when contacting Uscreen.
• Consider if the alternative integration options (webhooks, Zapier) could meet your needs before pursuing custom API access.

What can you do with the Uscreen API?

Based on the search results provided, here is a list of data models you can interact with using the Uscreen API, along with what is possible for each:

Users/Customers

• Create new users
• Update existing user information
• Grant access to content for users
• Retrieve user data

Content

• Retrieve video data
• Manage video content (likely includes adding, updating, deleting videos)

Sales

• Retrieve sales data
• Monitor sales and revenue trends

Subscriptions

• Manage user subscriptions
• Track subscription data

Analytics

• Access user engagement data
• Retrieve analytics on content performance

Integrations

• Interact with various third-party integrations like email marketing tools, analytics platforms, etc.

Sessions

• Create user sessions (e.g., for SSO-like functionality)
• Note: There are specific rate limits for the sessions endpoint

Other Possible Data Models

While not explicitly mentioned in the search results, based on typical API functionalities, the Uscreen API may also allow interaction with:

• Categories or collections of content
• Comments or user interactions
• Payment information
• Affiliate data (if Uscreen supports an affiliate program)

It's important to note that the full extent of the API's capabilities may not be covered in the provided search results. For a comprehensive list of all data models and possible interactions, it would be best to refer to the official Uscreen API documentation or contact their support team.