Skip to main content

Uscreen API

Empower your Uscreen experience through our API, designed for extended functionality and custom workflows

Updated over a week ago

Uscreen offers a powerful API that allows you to integrate your platform with external systems and customize your workflow. This article provides an overview of our API capabilities, access requirements, and implementation details.

API Access

To get started with the API, your Customer Success Manager can provide you with your API authorization key.

πŸ“ NOTE: Uscreen API access is available to customers on our UscreenPlus. If you're not currently on the Plus plan yet but need API access, you can reach out to sales@uscreen.tv to discuss upgrade options.

Publisher API Documentation

You can access our API documentation at:
​


Technical Implementation

πŸ“ NOTE: While our Support Team can provide basic guidance on API access and documentation, custom development implementation is out of the scope. For further assistance, please consult with a developer familiar with API integrations.

Authentication

All API requests require authentication using your API key. Include your API key in the request headers:

X-Store-Token: YOUR_API_KEY

Content Types

For most endpoints, you'll need to set the appropriate content type:

Content-Type: application/json
Accept: application/json

Common Endpoints

Here are some commonly used endpoints in the Publisher API:

  • POST /customer β†’ Create a new user

  • POST /customers/{customer_id}/accesses β†’ Assign a user to a specific membership

  • GET /tokenized_url β†’ Generate a one-time use magic link for SSO-style logins


Test the Implementation

Uscreen Interface

The simplest way to test the API is directly through our interactive documentation.

Authorize

  1. Click Authorization

  2. Enter your API key into the Header Value

  3. Click Authorize

Test Request

  1. Expand the endpoint you want to test

  2. Fill in the required parameters

  3. Click Try it out

  4. Click Execute to run the request

  5. Review the server response to ensure it's working as expected

Postman API

Postman is a popular API client that makes it easy to create, share, test, and document APIs.

Configure

  1. Sign up or log in to your Postman account

  2. Navigate to Workspaces

  3. Create a Workspace if you haven't done so, or open an existing one

  4. In Collections, click New

  5. Select HTTP

Test Request

  1. Select the appropriate HTTP Method

  2. Input the Base URL (Publisher API) + your chosen endpoint

  3. Fill out the required Headers and Parameters

  4. Click Send and wait for Response

πŸ’‘ TIP: Always test your implementation thoroughly before deploying to production. Use error handling to manage rate limit exceptions gracefully.

cURL Command

For command-line testing, cURL is a versatile option.

curl -X POST "https://uscreen.io/api/publisher/[API endpoint]" \
-H "accept: application/json" \
-H "X-Store-Token: YOUR_API_KEY" \
-H "Content-Type: application/json" \

Custom Test Environment

For more comprehensive testing:

  1. Create a test user in your account to simulate API interactions

  2. Set up a test script in your preferred programming language

  3. Implement error handling to manage rate limits and other potential issues

  4. Create test cases for different scenarios and edge cases

⚠️ WARNING: Always use test accounts and data when testing the API. Never use actual customers' data for testing purposes.


Rate Limits

To ensure optimal performance and fair usage for all customers, the Publisher API has the following rate limits:

  • General API endpoints: 100 calls per minute

  • Sessions endpoint: 10 calls per 5 minutes

πŸ“ NOTE: Please design your integration to work within these constraints by implementing proper request throttling and error handling in your code.

Other Limitations

  • Webhook creation and deletion via API is not currently supported.

  • When querying a User ID through the Publisher API based on webhook events, it is normal to receive a Record not found error for Admin accounts.

  • Webhooks may be triggered with up to a 10-minute delay, depending on system availability.


Alternative Options

If the API doesn't meet your specific needs, we offer other integration options.

πŸ”— Learn more about Webhooks

  • Receive real-time notifications about events in your Uscreen account

πŸ”— Learn more about Zapier Integration

  • Connect Uscreen with 7,000+ other apps without coding


Common Use Cases

Our Publisher API enables you to:

  • Customize checkout sessions

  • Redirect users to custom payment pages

  • Manage customers with external software or payment processors

  • Create new user sessions (SSO-like functionality)

Single Sign-On (SSO)

While Uscreen doesn't have native SSO support, you can use our Publisher API to create a similar experience. Web engineers can use the tokenized_url endpoint to create a new session in Uscreen after a user is authenticated elsewhere.

πŸ“ NOTE: This SSO method only works in web browsers and will not work for native mobile or TV apps.


FAQs

Is there an endpoint for products?

The Publisher API mainly allows you to manage customer data and content access. You can retrieve data on your offers using the /offers endpoint.

Can I use the Publisher API for email and password login?

Yes, our Publisher API allows you to create new users with email and password credentials. Additionally, we provide a tokenized URL endpoint for creating user sessions.

Will the Publisher API work with my mobile apps?

The Publisher API can also be used to retrieve data for mobile apps, but certain features like the SSO functionality (tokenized_url) will only work in web browsers, not in native mobile or TV apps.

Did this answer your question?