Our interactive API Reference allows you to try the BiblioGraph API endpoints. It is available to help you to make your first request and test the various parameters. For each endpoint, the interactive documentation provides you with the following:

• URL
• Description
• Parameter list
• Ability to try each endpoint with different parameters.
• Ability to see the response to a specified request.
• Code Samples in several languages. The code samples provided reflect the parameters entered into the reference parameter fields.

Interact with our endpoints and see the responses that you can expect back from BiblioGraph API. For each endpoint in our API Reference, the description, recent requests, parameters and response variations are displayed under the URL. The code samples and actual response are displayed in the right hand column. Explore the endpoints by following the sequence of steps below. Navigate to the BiblioGraph API Reference to begin.

Get Customer Information

The Get Customer Information endpoint is displayed when entering the BiblioGraph API Reference. The endpoint retrieves the details about the customer.

1. Click on bibliograph_domain in the Base URL section of the right hand column. A BiblioGraph domain pop up window is displayed.
2. Enter your institution's BiblioGraph domain. If you do not enter your BiblioGraph domain, the default value will be used.
3. Click on the EXAMPLES button in the RESPONSE section of the right hand column.
4. Click on the 200 in the drop down to see a successful example response.
5. Click on a language in the LANGUAGE section to see a code sample using the endpoint.
6. Click the Try It! button. The API reference makes a request to BiblioGraph API. The response is displayed in the RESPONSE section of the right hand column.

The /system.json response contains the customer details json object.

Get Data Resource Information

1. Click Get Data Resource Information in the left hand menu. The details for the /resource/{id}.json endpoint are displayed in the middle column.
2. Click on bibliograph_domain in the right column. A BiblioGraph domain pop up window is displayed.
3. Enter your institution's BiblioGraph domain.

📘

Your BiblioGraph domain will autopopulate if you have entered it when trying the previous endpoint.

4. Click on the EXAMPLES button in the RESPONSE section of the right hand column.
5. Click on the 200 in the application/json section to see a json successful response.
6. Click on a language under the LANGUAGE section to see a code sample using the endpoint.
7. Enter the desired resource id hash in the id field under PATH PARAMS.
8. Click the Try It! button. The API reference makes a request to BiblioGraph API with your desired parameter. The response is displayed in the RESPONSE section of the right hand column.

The /resource/{id}.json response contains the requested data resource information.