OAuth 2.0
OAuth 2.0 is a protocol that lets external apps request authorization to private details in a user’s 4me account without getting their password. This is preferred over Basic Authentication because tokens can be limited to specific types of data, and can be revoked by users at any time.
Before getting started, developers need to register their application in the Applications console of their My Profile section. A registered OAuth application is assigned a unique Client ID and Client Secret. The Client Secret should not be shared.
Depending on the use case, either the Authorization Code Grant or the Client Credentials Grant should be used:
- Authorization Code Grant
Allows third-party applications to access data on behalf of users in 4me after authorization of the application by these users. - Client Credentials Grant
Allows third-party machine-to-machine applications to access data in 4me. To be able to use this, the grant type ‘Client credentials grant’ should be selected.
Service URL
In order to successfully perform OAuth requests, the 4me application requires the use of a OAuth service URL that references the instance of a specific environment and region:
| Instance | Environment | Region |
|---|---|---|
https://oauth.4me.com |
Production | Global |
https://oauth.au.4me.com |
Production | Australia |
https://oauth.4me.qa |
Quality Assurance | Global |
https://oauth.au.4me.qa |
Quality Assurance | Australia |
https://oauth.4me-demo.com |
Demo | Global |