Claim Tokens

The Kigo API allows partners to facilitate token claims for their users. This process enables users to retrieve and redeem their tokens using a unique claim code. Tokens might represent offers, gift cards, or bundles, and claiming them unlocks associated content or benefits.

Prerequisites

Before making an API call to claim a token, ensure that the necessary user-level session token has been obtained. This token is required to authenticate API requests and can be acquired by following the User Client Level Authentication.

Steps to Implement

1. Checking a Claim Code

   • Purpose: This step allows an application to retrieve details about a token and any associated products before claiming it. This provides the user with information on what they are about to claim.
   • Endpoint Reference: Get tokens by claim code
   • Usage: Use the appropriate GET request to retrieve the token and product details associated with the claim code. This provides the necessary details for what can be claimed.

2. Claiming a Token

   • Purpose: Once the claim code is verified, this endpoint allows the user to redeem the token associated with the claim code.
   • Endpoint Reference: Claim a token
   • Token Claim: Once a token is claimed, it is marked as redeemed, and the associated content or benefits are unlocked for the user.

Key Considerations

1. Token Validity: Ensure the claim_code is valid and has not expired. A claim process will fail if the code is invalid or has already been redeemed.
2. Handling Unclaimed Tokens: If a user attempts to claim a token that does not exist or has already been redeemed, your application should handle this gracefully by informing the user and providing appropriate next steps.

Example Workflow

1. User retrieves details about a token using the claim code by referencing the Get tokens by claim code endpoint.
2. The application verifies the token's availability using the information returned by the claim code check.
3. Claim the token: The application sends the claim code to the Claim a token endpoint to complete the process.
4. Receive Confirmation: Upon a successful claim, the Kigo API returns a response with the details of the claimed token.
5. Provide Access to Content: The application grants the user access to the content or benefits associated with the claimed token.