Authenticating with AffinityLive
AffinityLive's API uses the OAuth 2.0 protocol and provides routines that cover web, service and installed application's authroization and authentication. It supports authorization code grants and client credential grants as necessary between the available API applications.
Please read OAuth 2.0's final version specification for more information on the protocol.
Contents
OAuth 2.0 Endpoints
The following OAuth 2.0 endpoints follow the base URI structure. Please remember that for installed and web applications the base URI structure contains the end-user's deployment and not the applications deployment.
Your base OAuth 2.0 URI structure is:
https://{deployment}.api.accelo.com/oauth2/v0/{resource}
For example
https://bobs-burgers.api.accelo.com/oauth2/v0/authorize
Table of endpoints
| Resource | Description |
|---|---|
| GET /authorize | Request Authorization from a user. |
| POST /token | Request an access token using a grant code or refresh token. |
For more information regarding these endpoints, please see the appropriate application type authentication documentation.
Recommended Client Libraries
AffinityLive recommends developers use existing OAuth 2.0 libraries when intereacting with AffinityLive's OAuth 2.0 endpoints due to the serious security implications of getting OAuth 2.0 correct.
A list of OAuth 2.0 Client Libraries can be found on OAuth.net/2/.
References and additional reading