Fetching Subscription Receipt and Connection Authorization Tokens

Implement proper caching of the tokens which you create and only create new tokens, if the previous tokens expired!

Create Subscription Receipt(s)

post

This will use the Identity Token (e.g. OpenID Access Token) to fetch one or more Subscription Receipt Tokens.

Authorizations

Any-XV-Access-Token

AuthorizationstringRequired

An XV_Access Token

Header parameters

x-client-app-versionstringRequired

The app version of the client making the request.

Example: 8.10.123

x-client-device-modelstringRequired

The type of the device making the request

Example: ["desktop","mobile","tablet","firetv","appletv"]

x-client-osstringRequired

The operating system of the client making the request.

Example: ["windows","macos","linux","android","ios","web"]

x-client-os-versionstringRequired

The operating system version of the client making the request.

Example: 10.0.1234

x-sdk-versionstringRequired

The SDK version making the request

Example: 5.0.123

Responses

200

The response contains an array of Subscription Receipts

application/jwt

400

Authorization header is missing

401

The provided authorization token is invalid, no customer id could be obtained for that access token

429

Rate limited

post

/srs2/subscription_receipts

HTTPcURLJavaScriptPython

POST /srs2/subscription_receipts HTTP/1.1
Host: <See Domain Reference>.com
Authorization: Bearer YOUR_SECRET_TOKEN
x-client-app-version: text
x-client-device-model: ["desktop","mobile","tablet","firetv","appletv"]
x-client-os: ["windows","macos","linux","android","ios","web"]
x-client-os-version: text
x-sdk-version: text
Accept: */*

{
  "srts": [
    {
      "srt": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjhjZGRlNDU3MWVhNzk5ZmRjNmQwOTgyYzg0Yjg0NjczZTcyZjQ4N2MifQ.eyJzdWIiOiIxIiwiaWF0IjoxNTE2MjM5MDIyLCJleHAiOjE3MTYyMzkwMjIsImVudGl0bGVtZW50cyI6WyJ4di52cG4iXX0.aRAZA2ioFUoL_GDpQ3_OSZaU50NVjIGkMRtF2bRzSiX7jsNycZ5fqjrS8mnPyu5k39j8JVUBAf1DIKtuJdNAoX9fc35_JcwVc2IzkvC0MNUSZ5ERpIG0ePwaU4rV5-2mMaevpQIjcJmHFVbyiRsc-ei6frP7Yr6VGaSoXI9AThmTm4CxsCIV9wdTverE0McwgCzYjL7O7eukeLYhPNKhWiTn2rRaLU8oHg_7rIqdP16OjZce8WAK64vpV3JfpQlRpfOXaCjIG4Gid4ESAxDSHX52jVGl8Xhj_hAfVjMq8Aj8leTTT7kgzo2lr17fL1LD3x7UWmZzZxhwk3Ux-M_exg",
      "subscription_id": "1"
    }
  ]
}

Create Connection Authorization Token

post

Creates a new Connection Authorization Token using the Subscription Receipt to authorize. The Subscription Receipt needs to contain the VPN entitlement.

Authorizations

Subscription_Receipt_Token

AuthorizationstringRequired

Uses the JWT Subscription Receipt Token

Header parameters

x-client-app-versionstringRequired

The app version of the client making the request.

Example: 8.10.123

x-client-device-modelstringRequired

The type of the device making the request

Example: ["desktop","mobile","tablet","firetv","appletv"]

x-client-osstringRequired

The operating system of the client making the request.

Example: ["windows","macos","linux","android","ios","web"]

x-client-os-versionstringRequired

The operating system version of the client making the request.

Example: 10.0.1234

x-sdk-versionstringRequired

The SDK version making the request

Example: 5.0.123

Responses

200

The response contains the raw, base4 encoded JWT

application/json

400

Authorization header is missing

401

The provided subscription receipt is invalid or expired

403

The provided subscription receipt is valid but lacks the VPN entitlement

429

Rate limited

post

/srs2/connection_token

HTTPcURLJavaScriptPython

POST /srs2/connection_token HTTP/1.1
Host: <See Domain Reference>.com
Authorization: Bearer YOUR_SECRET_TOKEN
x-client-app-version: text
x-client-device-model: ["desktop","mobile","tablet","firetv","appletv"]
x-client-os: ["windows","macos","linux","android","ios","web"]
x-client-os-version: text
x-sdk-version: text
Accept: */*

{
  "cat": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjhjZGRlNDU3MWVhNzk5ZmRjNmQwOTgyYzg0Yjg0NjczZTcyZjQ4N2MifQ.eyJhdWQiOlsieHYudnBuIl0sImlzcyI6Inh2LmNhdHMiLCJpYXQiOjE3MDEyMzkwMjIsImV4cCI6MTcxNzIzOTAyMiwiZW50aXRsZW1lbnRzIjpbInh2LnZwbiIsInh2LnZwbi5kaXAiXX0.bCYBMFaRz6gaDCAPYJfHRLW2dP7cMS8Zjsmip0--FB1WUPvnnLPZtDHC2dyjmLJNwPzzLrnLkhGKZDaDM8NbyGOfmSmZOgIwHRIYshiCT_IdVZkZuN_KrhzA-157-Si6LZ7Y6rXDXUA4l74xnoil-pv4EVvehziEnwzoNB7fAv1LcnLsDsjUIIG9yVfZkx9i1imm07p9UK1QyyXo0Iy45fnrkFwR_K38bnzaz_xGKiPSYDgJSTch0JioU4bTs3XaXJ1mWcBPThIA1k_kWSONZTMBOhHffVx6pKsAo7u7Av5ElWorh51JOXUkgoBjqnsyKf3d8N2WTADeiYE5r5ujMA"
}