Documentation API RESTful

1.    Overview

Tamburino (http://www.tamburino.it) is the online platform that collects and distributes the film programming data, theater and television nationwide.

Tamburino Shop allows, upon registration, to buy the programming of Tamburino. The acquired data will then be accessible through the content delivery system in XML and JSON formats, performing specific RESTful calls. Each user is identifiable by its own apikey to be specified for each call.

This guide aims to document the user who wants to access the data provided by Tamburino Shop, which steps to perform in order to register, buy and finally to download the information it has acquired.

 

2.    The Shop

Tamburino Shop, accessible via https://shop.tamburino.it, is an ecommerce site where you can purchase digital products. These products, as mentioned before, will be accessible through RESTful services. We will see in separate sections as you can then access these services.

 

2.1. Purchase

Like any e-commerce site, the user navigates in the virtual store and choose the products you are interested.

For each product must indicate what period must belong data of the product purchased. The period will be specified indicating the start date and how long you want the data.
In some cases other product features, such as the location, are required.

Once you have chosen the products to be purchased, the user goes into the cart performs login or if no credentials are registering. After making the payment via PayPal or later by bank transfer.

Only once made the payment the user will have access to data acquired.

2.2. Identification

Upon registration, which can be done either together with the first purchase that independently, the user is also recorded in the content delivery system and a apikey tag which is used to uniquely identify it.

In his personal area of Tamburino Shop the user can see their apikey. It will need to be used when calls are made for services that he bought.

2.3. Services

Always in the your Tamburino Shop, the user is shown the list of services which it has purchased.

For every line of this list is displayed on the product purchased, the start date and the end date of data availability.

Also appearing the URL to call and the Service ID.

This identified is essential in order to identify the actual service at the time of data request.

In fact every time you want to call a service is done through a URL that represents the product in question. This URL is completed with the Service ID.

2.4.  Example

If your product is a film program the URL to call is in the form

https://rest.tamburino.it/api/v1/movietheaters/programming/{SERVICE ID}

and for example its  Service ID is 456 and the user is apikey 1234567890abcdef, then for example the call to be made, with the parameters in GET, will look like this:

https://rest.tamburino.it/api/v1/movietheaters/programming/456?apikey=1234567890abcdef

In this case it was required film program in question from the date of “tomorrow” (default) for one day (default). The answer to this call is in XML format (default).

If you do not have access to the requested service or does not have access to the dates chosen then the call will return a HTTP error code.

 

3.    Il content delivery

Once the user has made the purchase of the desired products can access their data through RESTful services published by the content delivery platform.

The content delivery is available via the base URL https://rest.tamburino.it/api/v1 and for each type of service is a specific path to be concatenated to the base URL.

Click here  you can view the API documentation in which is specified in detail the list of possible services that you can call.