Overview

Request/Approval Steps

1. Application Owner submits HOLLIS API Request Use Agreement to LTS

• Use Agreement must include:
  • List of HOLLIS/Primo API areas you would like to access
  • For each area, summarize expected use case(s)

2. Application Owner registers directly for Primo Sandbox API access via the Harvard {API} Catalog (H{API})

1. Open Ex-Libris: Primo API in the H{API} Staging Portal: https://portal.stage.apis.huit.harvard.edu/ex-libris-primo-overview
2. Click Sign in in the upper right to log in with HarvardKey
3. Click your email address in the upper right and select Apps from the dropdown menu
4. Click the +New App button and fill out the form to register the application that needs API accessFollow these instructions to register for a HOLLIS/Primo Sandbox API key with the following settings:
   
   • App Name – brief name for API application or usename of application that will be using this API key
   • Description – detailed description of API application/use
   • App Owner – the person registering the app (the person logged in)
   • APIs : Select –  Select Ex-Libris Primo by clicking the plus sign next to it
   • When finishedcomplete, click the Create button at the bottom
   Make changes to an existing app
   • click Create to submit registration and create an API key.
5. Edit an existing Sandbox API key registration by selecting it from the Apps screen, editing the information, and clicking the Save button.
6. The API key string is available created as soon as the app registration is createdsubmitted, but it is not immediately active.
7. LTS receives notification of app registration and activates the API key in H{API}, typically within one business day. The HOLLIS/Primo Sandbox API Key is now activated for use.

3. Application development/testing using HOLLIS Sandbox API access

4. Application Owner submits all uses of the HOLLIS/Primo API to LTS for code review

• Use form category"API Use Review"
• Include all Required documentation for approval of production use of Alma/Primo APIs

5. LTS reviews API use as submitted and approves access to production API

6. Application Owner registers dierctly for Primo Production API access via the Harvard {API} Catalog (H{API})

1. Open Ex-Libris: Primo API in the H{API} Production Portal: https://portal.apis.huit.harvard.edu/ex-libris-primo-overview
2. Follow the same steps as for Sandbox API request (see 2. above) these instructions to register for a HOLLIS/Primo production API key. Values should match Sandbox (Step 2 above).
3. Edit an existing Production API key registration by selecting it from the Apps screen.
4. As with Sandbox, the Production API key is available immediately, but LTS must activate it for use, typically within one business day.

7. Application Owner performs final testing with production API, releases application for intended use