Creating an API Client and Secret
A ClientID and secret must be created to connect to the Vestigo Reporting API.
When creating the ClientID, you can set the facilities that this ClientID can pull information from, as well as the roles and permissions that this ClientID can have. The API account can be granted permissions for one or more API calls, and for a scope of one or more Vestigo Facilities.
The available endpoints are:
- BillingAccountContacts - Get
- BillingAccounts - Get
- BillingCharges - Get
- BillingPayments - Get
- InventoryTransactions - Get
- Patients - Get
- PatientSendOuts - Get
- Prescriptions - Get
- ProtocolBillingFees - Get
- ProtocolContacts - Get
- ProtocolInventory - Get
- ProtocolPatients - Get
- Protocols - Get
- SendOutDetails - Get
- SendOuts - Get
- ShipmentReceiptDetails - Get
- ShipmentReceipts - Get
- TimeBasedWorkload - Get
- UserRoles - Get
There can be multiple ClientID’s created with various permissions, but only one of them can have the permission Patients – Get. If a new Client ID is created and granted the Patients - Get permission, it will remove it from the other ClientID.
Creating a ClientID
To connect to the Vestigo API, you will need an API Key and API Secret. The API Secret will be available when the account is first created, but will then no longer be visible or accessible by any party. The API Secret should never be shared outside of development use of the API and should follow best security practices. If a Secret has been lost or compromised, the original can be revoked and a new one generated by selecting "Regenerate Secret".
- Navigate to Application Administration
- Click on Vestigo API
- Click on Create New Client Secret
- Select the appropriate facilities from the Facility dropdown
- Select the available API roles/permissions from the Roles dropdown
- Set an Expiration
- Click Submit
It is best practice to set an expiration for no greater than one year and regenerate the secret periodically.