Basic Authentication Guide

To interact with the Checkout APIs for Jira Cloud, you'll need to authenticate your requests using Basic Authentication. This method requires an API token and your email address.

Steps to Authenticate:

  1. Generate an API Token:

    • Log in to your Jira Cloud account.

    • Navigate to Account Settings.

    • Select Security.

    • Click on Create and manage API tokens.

    • Generate a new API token and store it securely.

  2. Prepare Your Credentials:

    • Combine your email address and API token in the format:

      user@example.com:your_api_token
  3. Encode Credentials in Base64:

    • Use a Base64 encoder to encode the combined string.

    • For example, in Python:

      import base64 credentials = 'user@example.com:your_api_token' encoded_credentials = base64.b64encode(credentials.encode('utf-8')).decode('utf-8')
  4. Include in HTTP Authorization Header:

    • Add the following header to your API requests:

      Authorization: Basic encoded_credentials Domain: https://<your-domain>.atlassian.net

Example

If your email is user@example.com and your API token is abcd1234, your combined string is:

Encoded in Base64, this becomes (for illustration purposes):

Your Authorization header will be:

Using the AssetType REST Endpoint

The AssetType endpoint allows you to retrieve information about different asset types managed within Checkout.

Endpoint URL:

  •  

Parameters:

  • This endpoint requires projectId parameters for a basic GET request.

Example Request Using cURL:

 

  •