Skip to content

Quickstart

Use this guide to make an authenticated API request in a few minutes. If you are integrating a physical device or building an Android control app, use the AWS IoT Core or Android SDK path below.

You need a TAMsys API key associated with your company. Request one from TAMsys support and keep it in a secret manager or server-side environment variable.

  1. Set your API key

    Store the key in your shell for the current session:

    Terminal window
    export TAMSYS_API_KEY='replace-with-your-api-key'
  2. List your devices

    Terminal window
    curl --request GET \
    --url 'https://api.tamsys.app/p/devices/list' \
    --header "X-API-KEY: ${TAMSYS_API_KEY}"
  3. Read the latest telemetry

    Replace DEVICE_ID with an id returned by the previous request:

    Terminal window
    curl --request GET \
    --url 'https://api.tamsys.app/p/devices/DEVICE_ID/data' \
    --header "X-API-KEY: ${TAMSYS_API_KEY}"
  4. Handle the response

    A successful request returns JSON with a 200 status. A device without an available reading, or one that is not assigned to your company, returns 404.