Contact support
    • Serverside.ai
    • REST API

    REST API: overview

    Table of Contents

    Overview API key Rate limiting

    Overview

    This document covers the Serverside.ai API, including secure API key management, request rate limits and monitoring, and guidance on limits and exceptions. A basic understanding of APIs, OTT video, and video advertising is assumed.

    API key

    All access is protected with a customer-specific API key, initially generated within the Serverside.ai application (Settings > Account). Be sure to save this key securely. It can be changed in the app but is never displayed, as we only transmit and store an encrypted version.

    Copy the API key immediately after creation and store it securely.

     

    Rate limiting

    The default limit of requests per minute is 200. This limit applies to the entire company. 

    If multiple users use the system, those requests, as well as requests made via the REST API, count toward the limit. 

    The HTTP headers provide all the information needed to monitor and manage your request rate.

    Example response headers:

    x-rate-limit-limit:200
x-rate-limit-remaining:197
x-rate-limit-reset:1591618796445

    Limits

    • The rate limit applies only to the configuration part and doesn't affect live or VoD delivery. 
    • If you need a higher limit for your company, contact support.
     

     

    RELATED ARTICLES