In this article, we describe the process for obtaining oAuth credentials in order to use the Class APIs.
- Customer process For customer who have signed an SSLA agreement. If you have and LFA or SSA agreement, then you will need to sign an updated SSLA agreement to gain access.
- Partner process For partners who would like to integrate with Class. Partners will need to sign an agreement first.
Customer process
You will need to Register your integration with Class in order to be issued with a set of credentials.
You will need to decide which flow you would like to use. The resource owner code flow and the authorization code flow are both available to customers. Class recommends using the Authorization code flow. Click on these links for more information.
This request needs to be made by an Access Controller in your business before sending the following information to setup your access:
- The flow you intend to use: Resource owner/Authorization Code.
- The email address and mobile phone number of your "Key developer" to receive the credentials.
If you chose the Authorization code flow, then these additional items are required:
-
- The redirection endpoints for your Application
- Your company logo in jpg format. Recommended dimensions : 180px x 55px
- Send an email to partners@class.com.au.
- A team member will receive your request
- Verification of API Use signed agreements will take place
- Confirmation of Integration will take place
- We will issue a set of client API credentials to access your data for all your business codes associated with your Class license.
For security reasons, the redirection endpoints registered for your integration must all be absolute URLs using https.
Partner process
You will need to sign a Partner agreement and register your Application/integration with Class in order to be issued with a set of credentials. Your Application will be required to follow the Authorization Code Flow.
You will need to provide the following details in your request:
- The OAuth redirection endpoint(s) for your Application
- Application logo (Format required: jpg, Logo will be resized to 180x55px if not provided in this size.
- Send an email to partners@class.com.au.
- The Partnership manager will receive your request and discuss your requirements.
- A partner agreement will need to be signed
- Class Issue PIE/Sandbox (Partner Integration Environment) oAuth credentials to develop your partner Application/integration
- Class reviews your completed Application and provide sign off for production. Class issues Production oAuth credentials to you.
For security reasons, the redirection endpoints registered for your integration must all be absolute URLs using https.
What's Next?
Please refer to the following documents for APIs:
- Choose and follow an Authorisation grant flow to retrieve an access token and refresh token. Refer to Authentication and Authorization