Health Check

Test and confirm that the Offer State API is up and ready to process requests.

GET /offers/state-reader/health

Take a look at our OpenAPI (Swagger-Spec) schema to learn more about the API calls.

This test endpoint ensures there are no known connectivity issues between AIR MILES and our partners. The HEALTH call functions similarly to a standard “ping” request, determining if a client or host is online and accessible.

Tip

It is highly recommended that all partners use the HEALTH endpoint upon starting their integration, to ensure both systems can communicate properly. Also at the partner’s discretion, we recommend performing periodic HEALTH tests at regular intervals to be notified immediately in the case of any unforeseen outages.

Sample request

curl -X GET \
  https://cert.airmilesapis.ca/offers/state-reader/health \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCI...' \
  --header 'Channel-Code: MOBAPP' \
  --header 'Accept-Language: EN'

Header parameters

Parameter	Description
Content-Type	Default value: `application/json`
Authorization	Token from authentication. Example: `Bearer <access_token>`
Channel-Code	Channel by which the transaction is called. The response will differ for different channels. Example: `MOBAPP`
Accept-Language	Language parameters, either “EN” for English or “FR” for French. Example: `EN`

Sample response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Mon, 29 Oct 2019 15:27:34 GMT
[
  {
    "healthy": true,
    "timestamp": "2022-08-18T19:00:53.151Z"
  }
]