Authentication

Include the following headers in every request:

  • X-API-Key – Your assigned API key
  • X-Merchant-Id – Identifier for the coffee shop
X-API-Key: 63f6b159256d2da6bbb687fa22a4a52aafc301007e1bb388937112c13037c518
X-Merchant-Id: J1S2bFlBHYae

If you are using Postman, add the following Global Variables:

  • TENCUPS_API_KEY
  • TENCUPS_MERCHANT_ID
  • TENCUPS_TAG
Endpoints
GET /

API status and documentation page (this page).

GET /v1/cup/{nfcTag}

Details of Cup.


          {
            "bean_code": "SB",
            "drink_code": "FLT",
            "extra_hot": false,
            "extra_shot": false,
            "milk_code": "DM",
            "super_hero": "Cassian Andor",
            "tag": "071d4b26eb0110"
          }
GET /v1/drink-codes

List of standard drink codes.

[
  { "drink_code": "ESP", "drink": "Espresso" },
  { "drink_code": "CAP", "drink": "Cappuccino" }
]
GET /v1/bean-codes

List of bean types: Normal, Decaf, Speciality, etc.

[
  { "bean_code": "DB", "bean": "Decaf" },
  { "bean_code": "SB", "bean": "Speciality" }
]
GET /v1/milk-codes

Milk options: Full Cream, Oat, Almond, etc.

[
  { "milk_code": "AM", "milk": "Almond Milk" },
  { "milk_code": "DM", "milk": "Dairy Milk" }
]
Status
Version v1
Maintainer Michael Goddard
Status Production