Introduction

This is documentation for Content API.

Content API is a RESTful API that allows searching for videos related to applications submitted to App Store. Currently only data from dailymotion apps is available and only small part of this data is indexed.

Authentication

In order to make requests to this API resources proper authentication is required. Client authenticates by supplying custom X-Api-Key HTTP header, e.g.:

GET /v0/videos HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Host: content.cloud.vewd.com
User-Agent: HTTPie/0.9.2
X-Api-Key: eea3f3d4-e216-40d5-8dbc-d9341aac77b4

The only resource that does not require authentication is Journal thata is intended to be used by the end user browser in order to track engagement for the purpose of personalization and content recommendation.

This method of athentication (i.e X-Api-Key header) is intended only for server-to-server communication and should not be used in the end user client code as it is impossible to secure authentication keys in user browser or application. If you need to communicate with Content API in other than server-to-server fashion, please contact us and we will provide you with details on other available authentication methods.

In order to obtain your own API key contact us directly by mail (see Contact info section).

Status of this API

Latest version of this API is v0. It is a prototype and expect anything to change.

Contact info

Michał Jaworski mjaworski@vewd.com Ask if you have any questions, need help or have suggestions.

API interaction

Note: informations in this section describe things that are well defined and are unlikely to change in future.

Since this is a REST there is a well defined mapping between HTTP methods and CRUD operations that you're probably familiar with:

POST

CREATE new resource

GET

RETRIEVE resource (or list of resources)

PUT/PATCH

UPDATE resource

DELETE

DELETE resource

Additionally this API is designed to be self-describing so we extend above dictionary with following:

OPTIONS

DESCRIBE resource endpoint

At the moment API talks only JSON and the base format for each response is:

{
    # Actual resource representation.
    # For the 'list' type of endpoint this is a list of
    # representations of single instance resource type.
    # For the 'instance' type of endpoint this can be
    # anything (refer to specific resource documentation)
    # but most likely it is an object.
    "content": (...),

    "meta": {
        "params": {
            # dictionary of params after parsing by Content API
            (...)
        },
        # additional meta data describing single response
        # e.g.: pagination, performance stats etc.
        (...)
    }
}