FAQ

How do I set up GOBI API?

The GOBI API enables real-time ordering from GOBI into Alma. When an order is submitted in GOBI, the API automatically creates a brief bibliographic record, inventory (physical holdings/item or electronic portfolio), and purchase order line (POL) in Alma, then links the POL back to the GOBI order. The steps below outline what CUNY campus library staff need to do, what to request from OLS, and when to coordinate with GOBI before testing and going live. Spreadsheet requirements may change over time and may differ from the details in this FAQ, so always follow the most current instructions provided by GOBI.

Overview

  1. Tell GOBI you want to set up GobiAPI.
  2. GOBI will send you:
    • Confirmation
    • Setup instructions
    • GOBI API Setup Worksheet
  3. Open a ticket with OLS requesting:
    • API key
      • Area: Acquisition
      • Environment: Production
      • Permissions: Read/write
    • GOBI API integration profile
      • Tell OLS if any of the following conditions should block an order from being created:
        • Order is not fully funded
        • Invalid fund code
        • Fund balance insufficient to cover encumbrance
  4. OLS will send you:
    • Your API key
    • Confirmation that the integration profile is set up in Alma
  5. Fill out the GOBI API Setup Worksheet.
  6. Send your completed worksheet to GOBI.
  7. If GOBI sends updated Tech Specs, review and approve them before implementation.
  8. GOBI will confirm when the API is implemented.
  9. In Alma, activate any Community Zone (CZ) electronic collections you will need for ebooks ordered via GOBI. (If the relevant electronic collections, such as EBSCOhost Ebooks, are already activated, you don't need to do anything.)
  10. Place 1–5 test orders via GOBI.
    • Orders are real and will be fulfilled and billed.
    • Testing cannot be done in Alma sandbox—you must use your live Alma instance.

GOBI API Setup Worksheet

Setup Basics tab

If you do not wish GobiAPI on a subaccount, delete that row from the worksheet.

Field Instructions
Date Today’s date
Requested by Name of GOBI Account Services Manager for Library Technical Services
Alma Base Path Select from drop-down menu:
America: https://api-na.hosted.exlibrisgroup.com
API Key Provided by OLS
Base Account GOBI base account number (e.g., 12345)
Library Library name (e.g., Brooklyn College)
Subaccount GOBI base account number plus two-digit subaccount number (e.g., 12345-01)

Can be found in GOBI at Library > "Library:" > Account Structure
Subaccount description Brief subaccount description (e.g., "EBOOK")

Can be found in GOBI at Library > "Library:" > Account Structure
US or UK Select region

Can be found in GOBI at Library > "Library:" > Account Structure
PO line owner (code) Format: XX001

Example: BC001

See "Campus Code" in CUNY Libraries Hub for two-digit code

Case-sensitive
Vendor code From the vendor record you use for ordering GOBI books in Alma (e.g., "GOBI")

Case-sensitive
Account code From the vendor record you use for ordering GOBI books in Alma (e.g., "GOBI Approval")

Case-sensitive

 

GobiSmart–API Mappings tab

Field Instructions
Date Today’s date
Base Account GOBI base account number (e.g., 12345)
Library Library name (e.g., Brooklyn College)
GOBI Field What GOBI calls the field internally. Do not make any changes.
Displayed? Yes = Display the field in GobiSmart

No = Do not display the field in GobiSmart
GobiSmart Label What the library calls the field
Select Yes = Field is required for Selectors

No = Field is not required for Selectors
Order Yes = Field is required for Orderers

No = Field is not required for Orderers
Validation list Yes = Select from list

No = Free text
Max Maximum characters allowed
Alma API Field Where the information will go in the Alma POL (e.g., "Receiving Note")
Notes Optional comments to GOBI

 

Validation Lists tab

Field Instructions
Fund Code(s) Alma fund codes (e.g., BCACC) used for GOBI orders. Do not provide fund names.

Can be found in Alma at Acquisitions > "Acquisitions Infrastructure:" > Funds and Ledgers
Location Code(s) Alma location codes (e.g., STACK) used for GOBI orders. Do not provide location names.

Can be found in physical title, holdings, or items searches.

Links & Files

Metadata

Answered By:
Kristen Fredericksen
Last Updated:
2025-09-05
Views:
15

Related Topics

FAQ Actions

Welcome

How can we help?

In order to submit this request for assistance, please first login by clicking the button below.
Login

The Systems Librarians in the Office of Library Services (OLS) are here to support CUNY libraries with:

  • Alma & Primo VE system support
  • EZproxy access and configuration
  • Documentation and best practices
  • Workflow optimization
  • Committee and working group support

Before submitting a ticket, please check our Knowledge Base for existing solutions to common questions. If you don't find what you need, fill out this form and we'll be glad to help!

Priority *
Fields marked with * are required.