Admin

Endpoints used by administrators and others who have been given an API key.

GET /assets/:id{?key}

Allows you to retrieve asset data for a given asset ID.

Requires a valid key provided via a X-Api-Key header or key query string parameter.

  • Parameters
  • Name Description Required Type Example
    id

    Asset ID

    Required string
    key

    The API key (You may send the X-Api-Key header instead)

    Required string client-9043a0f543e07f7ffa91a388
GET /register/:id{?key}

Allows you to register an asset with MMS (by sending one or two requests to the MMS TitleService API)

Requires a valid key provided via a X-Api-Key header or key query string parameter.

  • Parameters
  • Name Description Required Type Example
    id

    Asset ID

    Required string
    key

    The API key (You may send the X-Api-Key header instead)

    Required string client-9043a0f543e07f7ffa91a388

Backend

Endpoints used by backend services

POST /sync{?key}

Used by Amazon Simple Notification Service (SNS) to signal events on the topic tv4-vimond-assets

Requires a valid key provided via a X-Api-Key header or key query string parameter.

  • Parameters
  • Name Description Required Type Example
    key

    The API key (You may send the X-Api-Key header instead)

    Required string client-9043a0f543e07f7ffa91a388

Info

Endpoints containing information about the MMS Title Sync

GET /__status

Whatsup status document

  • Response 200 SHOW
  • < Content-Type: application/json; charset=utf-8