Developer
Entitlement services
Standard Entitlement Interface
2min
A Standard Entitlement Server provides an HTTP REST interface with methods to login, renew a session token, retrieve a list of issue numbers and logout.
It is configured with the URL and a token validity time.
By logging in, users obtain a session token that is required for all subsequent API calls.
POST
Request
Form Parameters
appId
required
String
the bundle identifier / package name of the app or a configured value
deviceId
optional
String
the unique device id of the calling device
username
required
String
the user name, in most cases an email address or a subscriber number
password
required
String
the users password
By renewing the token, users obtain an updated session token required for all subsequent API calls. The server must validate the token and may either return a new token or the old token, if actual renewal is not necessary for the use case.
POST
Request
Form Parameters
appId
required
String
the bundle identifier / package name of the app or a configured value
deviceId
optional
String
the unique device id of the calling device
token
required
String
the token retrieved by login or a prior renew
With the help of the session token, the system asks for a list of unique identifiers of issues. The implementation can deliver external issue numbers, which are configured as “Issue No.” in the Purple DS | Manager.
The special case of returning an array of exactly one empty string ([""] in JSON) is interpreted as “all issues without an Issue No.” and can be used to grant access to all app content, if this is the intended use case.
GET
Request
Query Parameters
appId
required
String
the bundle identifier / package name of the app or a configured value
deviceId
optional
String
the unique device id of the calling device
token
required
String
the token retrieved by login or renew
A call to logout should invalidate the token. Further calls to the API with the token are expected to fail.
POST
Request
Form Parameters
appId
required
String
the bundle identifier / package name of the app or a configured value
deviceId
optional
String
the unique device id of the calling device
token
required
String
the token retrieved by login or renew
Updated 11 Jul 2024
Did this page help you?