Skip to main content

Authorization

Follow this guide to create a new GitBook credential that will allow Nexla to authenticate to and exchange data with your GitBook account.
git_book_api_auth.png

GitBook

Prerequisites​

GitBook authenticates API requests using personal access tokens. Before creating a GitBook credential in Nexla, you will need to generate a personal access token from your GitBook account's Developer settings.

Generate a GitBook Personal Access Token​

  1. Sign in to your GitBook account at gitbook.com.

  2. Click on your profile avatar in the lower-left corner of the GitBook interface to open the account menu, then select Settings.

  3. In the left-hand navigation of your account settings, select Developer.

  4. Under the Personal Access Tokens section, click the Create new token button.

  5. Enter a descriptive name for the token in the Token Name field — for example, "Nexla Integration" — to help you identify its purpose later.

  6. Click Create to generate the token.

  7. Copy the token value immediately and store it securely. GitBook displays the full token only once at creation time. If you lose the token, you will need to revoke it and create a new one.

    Your personal access token provides the same level of access and privileges as your GitBook user account. Keep the token secure and do not share it in emails, chat messages, client-side code, or any publicly accessible location. Additional information about GitBook API authentication is available in the GitBook Authentication documentation.

Create a GitBook Credential​

  • To create a new GitBook 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.

API Token​

  1. Enter the personal access token you generated in your GitBook Developer settings into the API Token field. This token is used to authenticate all API requests Nexla makes on your behalf to the GitBook API at https://api.gitbook.com/v1/.

    The GitBook API uses the Bearer authentication scheme. Nexla automatically includes the token in the Authorization header of every request in the format Authorization: Bearer {your_token}. You do not need to add this header manually.

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.