Home > Appendices > API for Connector > Get Started
Export to PDFYou can refer to the sections below to get started.
Before using the APIs, you must register an app in AvePoint Online Services > Administration > App registrations and grant permissions to the app. With the registered app, you can use the generated application (client) ID for authentication.
Refer to the following URLs to access the page where you can register the app.
Commercial – https://www.avepointonlineservices.com/app/registration/index
U.S. Government – https://usgov.avepointonlineservices.com/app/registration/index
Refer to the Configure App Registrations for detailed instructions on how to register an app.
Once you have the application (client) ID, get the access token via the application (client) ID to authenticate with AvePoint Opus APIs.
The following information is required to get an access token:
| Element | Description |
|---|---|
| Identity Service Address | https://identity.avepointonlineservices.com (Commercial); https://identity-gov.avepointonlineservices.com (U.S. Government) |
| AOSAppClientID | The application (client) ID you have retrieved. |
| ConnectorCertificateThumbprint | The thumbprint of the .pfx certificate file of the .cer certificate you used when registering the AvePoint app. |
| ConnectorScope | The permissions you have granted to the AvePoint app. For AvePoint Opus, the scope is records.readwrite.all. |
To get the access token using the above information, create a JSON Web token using the Client ID and certificate first, and then use the JSON Web token to request an access token of the defined scope from AOS Identity Service.
Below is an example of getting the access token.
The token you get will expire in one hour, and you need to get the token again after the expiration.
When you use the AvePoint Opus API, you will need the API URL. The API URL varies with your data center. Choose the API URL according to your data center.