Generating developer tokens

Create a JSON Web Token to authorize your requests to the Apple Media Feed API.

Overview

The header of each Apple Media Feed API request requires authorization in the form of a developer token. A developer token is a signed token that authenticates you as a trusted developer and member of the Apple Developer Program.

The Apple Media Feed API supports the JSON Web Token (JWT) specification, so you can pass statements and metadata called claims. For more information, see the JWT specification and the available libraries for generating signed JWTs.

The Apple Media Feed API limits the number of requests you can make using a developer token within a specific period of time. If you exceed this limit, you temporarily receive 429 Too Many Requests error responses for requests that use the token. This error resolves itself shortly after the request rate decreases.

Create your developer token

Use the following information supplied by Apple through the Performance Partner Portal to create a signed JWT:

Team ID
Key ID
Private key

Create a developer token as a JSON object with a header that includes the following:

alg: The algorithm you use to sign the token, which requires the value of ES256.
kid: The key ID supplied by Apple.

In the claims payload of the token, include the following:

iss: The issuer registered claim key, the team ID supplied by Apple.
iat: The issued at registered claim key. This value indicates the time that the system generated the token, in UNIX time.
exp: The expiration time registered claim key. This value can’t be greater than 15777000 (6 months in seconds) from the current UNIX time on the server.
origin: (Optional) The origin claim, a list of authorized URLs. This addition helps prevent unauthorized use of the tokens and is recommended for web clients. Only use this claim if the origin header of the request matches one of the values in the list.

A decoded developer token has the following format:

{
    "alg": "ES256",
    "kid": "ABC123DEFG"
}
{
    "iss": "DEF123GHIJ",
    "iat": 1437179036,
    "exp": 1493298100
    "origin": [“https://example.com“,“https://tv.example.com“]
}

After you create the token, sign it with your private key using the ES256 algorithm.

Authorize requests

If you manage request authorization directly, in all requests, pass the Authorization: Bearer header set to the developer token.

curl -v -H 'Authorization: Bearer [developer token]' "https://api-feeds.tv.apple.com/v1/test"