Frequent Asked Questions

The Spideo API has its architecture based on an Application Programming Interface (API). This specifies a set of operations, inputs, outputs, and underlying types that allows you to understand how to integrate our personalized recommendation platform to orchestrate your OTT, VoD and Linear TV platform. Spideo API endpoints provide the building blocks that you need to build your product based on Rest APIs.

Most Spideo API endpoints can be tested with test/dynamic data through our API doc that is exposed here. This lets you see what each API endpoint does. Access to a demo environment will require you to contact our commercial team. Please contact sales@spideo.tv to request additional access.

Your username and password obtained during signup to the Spideo API Portal should be used to get access to the Spideo API documentation:

• On the home page click on “Sign up”.
• You will be redirected to the “Create your Spideo account” tab.
• Fill in the information for creating a new account with us.
• You will immediately receive an email that your request is pending for approval. - Your request approval may take a couple of hours.
• You will be notified about the approval in another email with further instructions.

The Spideo API Terms of Service are available at: https://developers.spideo.tv/terms-and-conditions/

Each resource within a REST API can support one or more of the standard HTTP methods. We define which verbs should be supported for each resource (GET, PUT, and DELETE) and their implementation. For example, a GET to the content resource should return a list of content.

The main HTTP responses will be:

• 200 - Ok - Standard response for successful HTTP requests.
• 204 - No content - The server successfully processed the request and is not returning any content
• 403 - Forbidden when authentication is required and has failed or has not yet been provided. (Missing API Key)

In order to keep you in charge of each dummy user that you want to create while performing an API call, which requests you to create a user profile and understand its interaction, we recommend you to follow the following process: Create a user name using the three initials of your company followed by three numbers. For instance, if you work for Spideo then you could choose to create a user called spi100 and respectively spi101, spi102, and so on.

We use a variety of security systems to safeguard the information we maintain and provide. Find out more in our Terms of Service. Our Spideo API supports throttling settings for each method in your API endpoints. You set a standard rate limit and a burst rate limit per second for each method in our REST APIs. Also we monitor the usage by third-party developers, and we provide a stronger mechanism for authorization.

In order to safeguard the information we maintain and provide we use IP whitelisting and Api Key authentication

Our API Doc consists out of different categories in which you can find endpoints that match the specific features of each section. These are:

• Content-related services: Provide relevant and self-explained content-to-content recommendations.
• Topic based services: Help people discover relevant content according to their topics of interest.
• Search: Find content by titles, cast and keywords.
• User interactions: Help you store, retrieve and delete individual user's interactions
• Profile-based suggestions: Provide content to user recommendations based on the user history of interactions.
• Business rules: Control how recommendations are being displayed, precise restrictions and fallback rules

No, you cannot. Our Spideo API is a closed source.

Yes, this document will be updated from time to time. We maintain a new feature and deprecation feed in our Spideo API Doc.

Get in touch with our commercial team and they will contact you. sales@spideo.tv

Integration Process All our services are served via Restful API. We deploy the technical environment for our customers on cloud services using AWS or “on-premises”.
This process will depend on the type of service architecture of your IPTV/OTT/Content platform. Most of our partners have chosen to use our Spideo cloud services, as AWS cloud servers offer reliability and scalability.

• 1. Integration process for VoD:
Operator’s will send content exports on JSON or CSV file to Spideo. These files contain:
• 1. Content ID (your content ID)
• 2. External IDs (to match all content in our database. Which could be IMDB, Plurimidia or TMS(Gracenote).
• 3.For VoD some metadata about the content such as Content Title, Casting, Director, Release Year, Type of content (Film/Series). If part of this metadata is not available, we will continue being able to index your content, but it might increase the estimate time to complete the import/export process.
• 4. Availability Information about the content (start data and expire data)
• 5. User ID & User History (if there is no existing user history, we can create the user profiles on the fly). No sensitive data of the user is necessary.
• Integration Process for TV – Linear TV – Live Content:
We index the channels using Plurimidia or TMS(Gracenote) metadata.
• 1. List of TV channels/List of lineups
• 2. Using the Spideo Cloud-based services environment, your solution will be set up in an estimated time of 2 to 3 weeks with the first content (imports/exports) concluded.
For further information, contact our sales team email: sales@spideo.tv

Have further questions or in need of support? Get in touch with us at support@spideo.tv