Entitlement API
The entitlement functionality can be used to validate an email and password for either a user, contact, or subscriber. For users the functionality is limited to getting basic information about the user. In this way it can be used as a single sign-on mechanism for an external application to validate users by their Ad Orbit credentials. For contact and subscribers the available functions include login validation and basic information like for users, but also additional endpoints for getting subscriptions or issues that are available based on their subscriptions. Making a Request:The format for requests is the same as for the general API functionality. Please read the API documentation for information about how to generate the Authorization header for requests. Note that while a user’s public and private keys will be used for entitlement, the user must also have checked the “Use API for Entitlement Only” box for the entitlement endpoints to be available. This means these keys will not be able to access the general API endpoints, but instead will only have access to entitlement for security. If the desire is to use both the general API endpoints and entitlement, then two separate sets of keys will need to be used. The accept header is the same for all entitlement requests:
application/vnd.adorbit+json;version=1.0
Entitlements:
{
"Entitlement (login)": POST: "path-to-domain/entitlement",
"User Information": POST: "path-to-domain/entitlement-user-info",
"Issues": GET: "path-to-domain/issues-by-token/{token}",
"Subscriptions": GET: "path-to-domain/subscriptions-by-token/{token}",
"Issues by Subscription": GET: "path-to-domain/issues-by-subscription/{subscription id}/token/{token}",
"Issues by Publication": GET: "path-to-domain/issues-by-publication/{publication id}/token/{token}",
}