Introduction

The Kigo API is a RESTful JSON API for integrating with the Kigo platform. Partners use it to authenticate their members, sign them in to Kigo-hosted experiences, and work with accounts, offers, merchants, orders, and tokens on their behalf.

Base URL

All endpoints are served over HTTPS under the /api/v1 path:

https://api.kigodigital.net/api/v1

Every integration is built and tested in Kigo's test environment before going live. Kigo provides separate credentials for test and production.

Requests and Responses

  • Send request bodies as JSON with Content-Type: application/json.
  • Authenticate with a bearer token in the Authorization header. Which token an endpoint needs is listed on its reference page. See Authentication.
  • Errors return a JSON body that you can match on. See API Errors.

API Areas

AreaWhat it covers
AuthenticationPartner-level, user-level, and anonymous session tokens; SSO session exchange.
AccountsMember accounts, profiles, SSO sessions, and points.
OffersSearching, viewing, and redeeming offers.
MerchantsMerchant details and locations.
OrdersOrder details and status.
TokensItems in a member's wallet: viewing, redeeming, sharing, and hiding.
UtilitiesAddress and location helpers.

To get started, see Getting Started.


What’s Next

Did this page help you?