The API feature makes it possible for a website or application to access vdsapps resources using OpenID Connect or OIDC, which is is an identity protocol that utilizes the authorization and authentication mechanisms of OAuth 2.0.
The below instructions provide a high-level overview of the steps necessary to access vdsapps' API endpoints.
Required Permissions
RapIDadmin → APIs → API Documentation
RapIDadmin → APIs → Applications
RapIDadmin → Connections → Create Connections
The following information applies to Developers only. Contact Vision Database to request Developer access.
Applications
Navigate to API > Applications
Create an application
Click Create
The Create An Application modal window will open.
Input a Name for the application
Select the applicable scopes (RapIDadmin, EliteID, PerfectPass)
Click Create
After the application has been created two new tabs will appear: Production and Development.
In addition a Client Id will be assigned to the application.
Optionally, to access the OpenAPI (Swagger) documentation:
Open the Development tab
Copy and paste the redirect link into the Redirect Uri input box then click ADD.
Click Save to complete the setup
https://www.vdsapps.com/rapidadmin/swaggerui/redirect
API Documentation
Navigate to API > Api Documentation
API Documentation is available for RapIDadmin and EliteID. In the below example we’ll authorize an OpenAPI application and query the EliteID getallwithphotoupdates API endpoint using Swagger UI.
To start the authorization process first gather the app’s Development Client Id.
Navigate to API > Applications
Click Actions > Edit
Open the Development tab
Click the Copy button below the Client Id (the dev Client Id will start with “dev_id”)
Return to API > API Documentation
Authorize
Select EliteID from the Application list
Click the Authorize button
Paste the dev_id Client ID into the client_id input box.
Enable the applicable scopes (they must match the app’s scopes or the authorization will fail)
Click Authorize
Grant Approval
After clicking the Authorize button a new browser tab will open and a prompt will confirm the application name and application scopes.
Click Approve
The Approval Required tab will automatically close and you’ll be returned to the API Documentation page, and the modal will now read “Available authorizations”.
Click Close
Query the endpoint
Click Try it out
Click Execute
Scroll down the page to view the Response
Connections
Applications that are granted access to one or more vdsapps applications are listed on the API > Connections page.
To revoke an application’s access follow the below instructions.
Revoke Access
Click Actions > Revoke to revoke that application’s data access
Click Yes at the prompt