Skip to main content

Authorization | Climes API

The Climes API's uses x-api-key authorization.
You can retrieve your API keys from the API key page in the Climes Partner Dashboard.
On your API key page you will see two API Keys.
One will be staging-api-key and other will be production-api-key.

danger

Do not test in Production environment.

Please set the headers with

  • Content-Type as application/json
  • x-api-key as API_KEY
note

Climes provides 2 environments

  • Staging for testing out the endpoints
  • Production for going live

For the rest of the documentation

  • BASE_URL will refer to the base url for the endpoint
  • API_KEY will refer to the API_KEY to be used for x-api-key
tip

Your API keys indicate when they are production or test keys.
Production keys have the prefix climes_prod while test keys have the prefix climes_staging

Endpoints​

Sample Order API Request​

curl --location --request POST 'BASE_URL/v3/integrations/vote/order' \
--header 'x-api-key: API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order": {
        "climes": 557,
        "partner_order_id": "876287372837786837",
        "customer_email": "johndoe5675533@gmail.com",
        "customer_name": "John Doe",
        "customer_phone": "+916355129211",
        "unlock_date": 1660933800000
    }
}'