Skip to main content

Authorization

Follow this guide to create a new Gutendex API credential that will allow Nexla to authenticate to and exchange data with the Gutendex API.
gutendex_api_auth.png

Gutendex API

Prerequisites​

The Gutendex API is a completely open, public service that requires no API key, access token, or user registration. Anyone can make requests to the API immediately without any prior setup.

About the Gutendex API​

Gutendex is a self-hostable JSON web API that serves metadata from Project Gutenberg's catalog of public domain books. The public instance is available at https://gutendex.com and is freely accessible without credentials.

For long-term or high-volume production usage, Project Gutenberg's official documentation recommends running your own Gutendex server instance using the open-source code available at https://github.com/garethbjohnson/gutendex. This ensures availability and avoids placing excessive load on the shared public endpoint.

Create a Gutendex API Credential​

  • To create a new Gutendex API credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Base URL​

  1. Enter the base URL for the Gutendex API in the Base URL field. The default public endpoint is https://gutendex.com. If your organization runs a self-hosted Gutendex instance, enter the base URL of your private server instead.

    The base URL should not include a trailing slash or any path segments. For the public Gutendex instance, use https://gutendex.com exactly as shown.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.