TAŇBA-OOH Developers

Enrol a player

A player takes part in the platform once it holds a device certificate. The operator issues a one-time token in the console, the player exchanges it for the certificate, and from then on the console shows the player and its state. This guide covers the console side and what to check afterwards.

Related pages: Device protocol v1 for the calls the player makes, and Send proof of play for what it reports once enrolled.

Before you start

Issue a token

  1. Open Players and choose Enrolment token.
  2. Pick the structure the player belongs to. Only active structures are listed.
  3. Choose Issue. The token is shown once, in a read-only field, and starts with tdt_. Copy it now.

The token is valid for 24 hours and works once. It is tied to the structure you picked, so the player appears under that structure. If the token is lost, expired or already used, the player's request is refused with invalid_token; issue a new one. The platform limits the number of enrolment requests from one address.

What the player does

The player makes a key of its own (ECDSA P-256), sends a certificate request together with the token to POST /d/v1/enroll, and receives a device certificate valid for one year and the chain up to the device certificate authority. The token is the only credential of that call; every later call presents the certificate. The player also states its model, firmware version, serial number and the version of the conformance specification it claims. How to enter the token on the player is described by the maker of the player software.

Check that it is enrolled

The Players table lists each player with its structure, model, firmware, status, mode and last signal.

StatusMeaning
Never connectedEnrolled, no heartbeat received yet
OnlineThe last heartbeat is no older than 2 minutes
LateThe last heartbeat is older than 2 minutes but within the limit below
OfflineThe last heartbeat is older than 10 minutes (players of class A and B) or 60 minutes (class C)
RevokedThe certificate is revoked

A new player shows Never connected until its first heartbeat, then Online. The Mode column shows what the player reports: Normal, Compliance mode (it lost contact with the platform for longer than the limit of its class) or Cut off (a signed cut-off command switched it off).

A player marked Signed-only authenticates with a signature of a registered key instead of a client certificate, at application level. The mark is shown next to its model.

Revoke a player

To retire a player, or when its key may be exposed, choose Revoke in its row, enter a reason of up to 500 characters and confirm. The player loses access to the control channel. This cannot be undone. A revoked player shows Revoked and has no further actions.

If it does not appear

SymptomCheck
The player's request is refused with invalid_tokenThe token expired, was used, or was copied wrongly. Issue a new one
The player is listed but stays at Never connectedThe player has not yet sent a heartbeat: check that it can reach https://devices.tanba-ooh.kz
The structure is not offered when you issue a tokenIt is not active, or it is registered by another organisation