Overview
In this article, we describe the process that is required for Clients to connect to Class API's to consume their data.
Client Model
- Clients use the Class app to administer their entities for their practice.
- Must have a current subscription (SSLA) to Class and want to gain access API access to their data. (If you are not sure if you are on the SSLA agreement with Class, reach out to partners@class.com.au to confirm your agreement type:
LFA or SSA will need to be updated to Software Service License Agreement (SSLA) to enable API access).
Only the user that is the Access Controller in your business is allowed to raise an API access request.
The customer model supports both Authorisation Code Flow and Resource Owner Password Flow under the OAuth 2.0 framework, with bearer tokens to manage authorisation. Provide these OAuth links to your developer.
API Keys
API keys will be provided to your developer that understands how to build the integration. These keys are your responsibility and should be kept secure, as it allows access to your data.
If you don't have a developer that knows how to build the integration, please feel free to contact a Class Development Services partner listed on our website to assist you. Additional information we need:
- The flow you intend to use: Resource owner or Authorisation Code Flow.
- 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 : 180p x 55px
Process
- Ensure that you are on the right agreement (SSLA).
- An access controller can raise this request to partners@class.com.au. If an fund administrator is raising the request. Then will need the access controller approval to provide the API keys.
- Partner support will go ahead and issue API keys on Class production to your designated developer.
- Your API keys will only allow you access to Class business codes owned under your SSLA.
What's next
Start making some API calls and visit our API reference page for more details..