Guides

Getting Started

Suggest Edits

Step 1: Obtain API Credentials

Before interacting with the Kigo API, ensure:

  • API Key: A secret key provided by Kigo.
  • Partner ID: A unique identifier associated with the partner organization.

A partner can obtain these values from their primary contacts at Kigo.

Step 2: Authentication

Before making any API requests, a partner must authenticate by obtaining two levels of session tokens: an account-level session token and a user-level session token.

  1. Create an Account-Level API Session Token:

  2. Create a User-Level API Session Token:

  3. Include the Tokens in Requests:

    • For subsequent API requests, include the User-Level API token in the Authorization header as a Bearer token.

For more details on authentication, see the API Authentication guide.

Step 3: Interact with the API

With authentication set up, an application is ready to interact with the rest of the Kigo API. Here’s an example of how to list gallery tokens associated with a user account.

Example: Listing Gallery Tokens

A gallery token is a minimal representation of a token, designed for use in a list of tokens. It includes essential information like the token ID, name, description, and associated media. To retrieve a list of gallery tokens belonging to a user, use the following endpoint:

While gallery tokens provide a quick overview, an application can obtain the full details of any token by retrieving it directly via its ID. To do this, use the following endpoint:

This will return comprehensive information about the token, including all associated metadata and attributes, beyond what is provided in the gallery view.

Step 4: Review API Documentation

Refer to the detailed API documentation for information on all available endpoints, request/response formats, and example use cases. Each API endpoint is documented with detailed descriptions and examples to help a developer integrate seamlessly.

Updated 5 months ago