Getting Started

Step 1: Obtain API Credentials

Kigo provides each partner with:

• Partner ID: A UUID that identifies your organization.
• API Key: A secret key for your organization. Keep it on your servers.
• external_program_id: The identifier of each program your members belong to.

Your Kigo account manager shares these values through a secure channel. Separate credentials are issued for the test and production environments.

Step 2: Authenticate

The Kigo API uses two levels of session tokens. Both are created from your server.

1. Create a partner-level session token (valid for 1 hour):

   • Endpoint: Create a session token

2. Create a user-level session token for a member (valid for 1 hour, with a refresh token valid for 365 days):

   • Endpoint: Create account session
   • Send the partner-level token as the bearer token.

3. Call member endpoints with the user-level token:

   Authorization: Bearer <user-level session token>

For details, see the Authentication guide and User-Level Authentication. To sign members in to a Kigo-hosted experience instead, see Creating an SSO Session.

Step 3: Make a Request

With a user-level token, your application can call the member endpoints. For example, to list offers available to the member:

• Endpoint: Get offers

curl https://api.kigodigital.net/api/v1/offers \
  -H "Authorization: Bearer <user-level session token>"

To get the full details of a single offer, use its ID:

• Endpoint: Get offer by ID

Step 4: Explore the API Reference

The API reference documents every endpoint, including the token it requires, its request and response schemas, and examples. Error responses are described in API Errors.