SERVERSIDE.AI
  • Welcome to serverside.ai
  • Getting Started
    • Prerequisites
    • Onboarding Guide
      • Serverside.ai: Create an account
      • Prepare content source
        • Encoding specification
        • Packaging specification
        • Ad-Marker specification
          • SSAI LIVE - SCTE35
          • SSAI VoD - AdCuePoints
      • Request SSAI enabled stream
    • Features
  • Content Source
    • Encoding
    • Packaging
      • HLS
      • DASH
    • Protection
    • Ad-Marker Specifications
  • Video Player/App
    • Live - DASH/HLS
    • VOD - DASH/HLS
    • VAST Tracking
      • Live - DASH
      • Live - HLS
      • VOD - DASH/HLS
      • ClientSideTracking SDK
    • Timeshift/Startover for LIVE
    • Playlist size for LIVE
    • PauseLiveTV
  • Ad-Server Integration
    • Ad-Server Parameter
      • Equativ/ SmartAdServer
      • Freewheel
      • Google Ad Manager
      • SpotX
    • GVA - Generic VAST Adapter
      • GVA - Configuration
    • 3rd Party Audience Data Integration/DMP
  • Ad Media Condition and Delivery
    • Ad Media - Origin integration
    • Ad Media - CDN integration
    • Prefetch API
  • Manual - User Interface
    • Account
    • Channels/Streams
    • Reports
    • Assets
  • REST API
    • Channels
      • API routes - Channels
      • VOD Channels
      • Detailed channel analysis errors
    • Reports
      • API Routes - reports
    • Playlists
    • Error responses for all routes
    • Further Documentation
  • Support
    • About support case management
    • Creating a case
    • Case language
    • Case processing
    • Booking a meeting
    • Requesting elevated attention
    • Closing a case
  • FAQ - Questionnaire - Glossary
    • Q&A
    • Questionnaire
    • Glossary
    • Files
  • Quality of Service
  • Release Notes
    • Version 2.1.0.x
    • Version 2.0.7.x
    • Version 2.0.6.x
    • Version 2.0.5.x
Powered by GitBook
On this page
  • API Key
  • Rate Limiting

REST API

Introduction to the serverside.ai API

PreviousAssetsNextChannels

Last updated 1 year ago

Important

The documentation assumes that you are familiar with a basic understanding of API interaction, OTT video processing, and video advertisement.

API Key

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

Please copy the API-Key right after the creation and store it in a safe place.

Rate Limiting

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

If multiple users use the System those requests are taken into account as well as the requests via the REST API.

The HTTP header contains all information needed to throttle your request rate.

Example Response-Header:

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

The rate-limit applies only on the configuration part and doesn't affect the Live and VoD delivery.

Please contact support to request an increase in the limit for your company.