Development 4YouSee Manager API

4YouSee Manager API Documentation.

Requests & Authentication

All API access is over HTTPS, and accessed from the api.4yousee.com.br domain.
All data is sent and received as JSON and all calls require a Secret-Token
HTTP header with the value obtained from 4YouSee Manager.

If you need more information to access the 4yousee tokens click on this link.

Rate limit

There is a limit of 1 call request per second ("IP/URI" combination).
In case application client exceeds that limit a 429 HTTP status will be returned.
Excessive requests may raise a permanent token/IP block.

Paging, sorting and filters:

All listing features are paginated and have a default limit of 100 records.
To optimize your searches, some variables are available in the listings.

page

An integer that represents page size. Default is 1

limit

An integer that will limit returned result.
If a number greater than 100 is entered, default value (100) will be considered.

sort

Some fields are available for sorting. Each endpoint has specific fields.

• ASC: one or more comma-separated fields. Example: ?sort=id,name
• DESC: One or more comma-separated fields with sign - before them. Example: ?sort=-id,-name

In the listing endpoints there are 3 auxiliary variables for the interaction between the pages.

total Total records found considering possible filters passed in the query string

currentPage Current page.

totalPages Total pages.

For example:

{
    "results": [
        //...
    ],
    "total": 353,
    "currentPage": 1,
    "totalPages": 4
}