Manage API accounts

Before using Destiny Open APIs to integrate with an app you developed or a third-party app, the Destiny Administrator must set up an API account with credentials for the particular API client.

Destiny can integrate with several API vendors to help you manage patron checkouts, resources, and fines/fees.

Add an API account for clients

1. Log in as a Destiny Administrator.
2. Select Setup > API sub-tab.
3. Click the Add API Account icon, . The Add API Account page appears.

   

4. Enter the Name for the new API account.
5. For Credential, either:
   • Select Follett App ID, and then enter the ID number in the field.
   • Select Client Credential (OAuth2), and then click Update.

     These random alpha-numeric strings are the credentials for getting an access token. Share them discretely and securely with the API Account user (often a developer).

     Note: Treat these credentials confidentially, like you would any other username and password.

6. Under Services, select the services the account can access:
   • Fines: This API can be used to get fines across the district.
   • Self Service: This API was designed to support the Follett reader and can be used to look up library titles, a patron's checkouts, and recently read eBooks and audiobooks.
   • Patron Info: This API can be used to look up patron checkout information, like checkouts at a district or site.
   • Resources: This API can be used to get the whole resource template tree or a specific resource type by name or ID.
7. Click Save.
   

   Note: An API Terms And Conditions pop-up is presented each time you create a new API account. Click I Agree to continue.

Edit an API account

1. Log in as a Destiny Administrator.
2. Select Setup > API sub-tab.
3. Click the Edit icon, . The Edit API Account page appears.
4. Make updates as needed, then click Save.

Important: See the Destiny Open API’s Developer’s Guide for integration details.