- Can I make changes to the API?
- Does the API ever change? How can I learn about new features?
- Which API endpoint do I need?
- What is a method?
- What security measures are used to keep data secure?
- What are the usage limits?
- How do I create an User profile to perform a specific user interaction on the API call?
- What are the HTTP messages and errors?
- How to perform a API call?
- What is the Spideo API?
- What are the Terms of Service for using Spideo API?
- After testing the API how do I request a PoC to create a Demo environment?
- Do I need an API Key to perform tests?
- Do you have documentation for your API?
- How long does a Password and API Key last?
- Do I have to pay to test the Spideo API?
- How do I get access to the Spideo API?
- What does Spideo do?
- What is the Spideo API Doc?
- Have further questions or in need of support?
- What is necessary to integrate my services with Spideo?
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.
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: help you retrieve recommendations based on a specific type of content in various ways
- Search: enrich the results that are being returned for a specific type of search coming from a user
- User interactions: help you store, retrieve and delete individual user's interactions
- Profile-based suggestions: recommendations based on the individual user's profile
- Business rules: control how recommendations are being displayed, precise restrictions and fallback rules
- Taxonomy: generate a list of all the keywords available in a given content universe
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.
In order to safeguard the information we maintain and provide we use IP whitelisting and Api Key
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 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.
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
401 - Unauthorized when authentication is required and has failed or has not yet been provided. (Missing API Key)
First sign up to get access to our Spideo API. Once you have your username, password and the
API Key, sign in to the our Spideo API web portal. Select on the drop-down menu what block of
functionalities you want to test the API endpoints. These are the block of functionalities available:
Content Related Services
Profile Based Suggestions
Once you have chosen what block of functionalities you would like to test, you have to add your
API Key when clicking on the “API Key” button located on top left of the page.
Add your API key and click “OK”
Once you have gone through authorization you will be able to perform any API call, selecting
a specific endpoint and selecting “Send this Request”.
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.
The Spideo API Terms of Service are available at:
Yes, you do. You need to complete your registration to our API Doc and agree with our Terms of
Conditions to receive your API Key.
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 email@example.com to request additional access.
Passwords for the developer portal will expire 90 days after creation or last change.
No. However when you register for an account, you will receive a key that gives you limited
access to the APIs. You may request to be upgraded to a free Sample plan that enables you
additional access for 30 days. Please contact the Spideo sales team: firstname.lastname@example.org
Your username and password obtained during signup to the Spideo API Portal should be used to
generate an API Key. These are the steps to grant your user access and your private API key:
- On the home page click on “Register”.
- You will be redirected to the “Create new 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.
Spideo is a SaaS product that specializes in building unique user experiences and personalization through semantic algorithms in easy-to-use discovery tools. We help content providers by providing valuable customer insights to better understand their users and optimize the performance of their content catalog.
Have further questions or in need of support? Get in touch with us at email@example.com
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:
a. Content ID (your content ID)
b. External IDs (to match all content in our database. Which could be IMDB, Plurimidia or TMS(Gracenote).
c. 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.
d. Availability Information about the content (start data and expire data)
e. 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.
2. Integration Process for TV – Linear TV – Live Content:
We index the channels using Plurimidia or TMS(Gracenote) metadata.
a. List of TV channels/List of lineups
3. Using 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: firstname.lastname@example.org