Skip to content

Getting Started

Jump to bottom Edit New page
GeneStevens edited this page Mar 9, 2012 · 2 revisions

This section describes how to get started with using our APIs.

API Access Tokens

Access Tokens are used to manage access to the API. With these tokens, you can use the API to:

  • Provision your tags
  • Configure your tags
  • Download analytics and general usage
  • Share your tags with 3rd parties

Each customer has at least one Access Token. In order to use this API, you must subscribe to a service plan that includes the Tag Management API.

Access Token Format

Access Tokens are UUIDs which look like so: cee1d876-d91d-4ed0-9093-8054341e3f41

Retrieving your Access Token

Access Tokens can be found within the Administrative Portal. Once logged in, navigate to Account --> Access Tokens.

Basic Usage

An Access Token needs to be attached to each API request in the form in the X-ActiveTag-AccessToken custom HTTP Header. Failure to do so will result in an "401 Unauthorized" response.

Access Token curl example

curl -v -X GET \
     -H 'X-ActiveTag-AccessToken: cee1d876-d91d-4ed0-9093-8054341e3f41' \
     https://api.taglabsinc.com/tags/items

API URL Endpoints

All API requests sent through our system go to this server address:

  • https://api.taglabsinc.com

This address is load balanced across our infrastructure. Each individual API will hang off this address with its own URI. For example:

  • https://api.taglabsinc.com/tags/items
  • https://api.taglabsinc.com/analytics/scans

Refer to each API's documentation for specific examples.

Accommodating non-HTTP/1.1 Clients

Despite the fact that the RFC has existed since 1999, not all HTTP clients are HTTP/1.1 compliant. And even then, some clients who must observe Same Origin Policy are artificially restricted for security reasons. Toward that end, the following Query Parameters can be used to substitute for an inability to use the PUT and DELETE HTTP methods and for the occassional inability to set custom HTTP Headers:

  • method_override - This can be used to turn a POST into a PUT or a GET into a DELETE

    E.g., ?method_override=put

  • access_token - This can be used to specific the value for 'X-ActiveTag-AccessToken'

    E.g., ?access_token=cee1d876-d91d-4ed0-9093-8054341e3f41

Add a custom footer
Add a custom sidebar

Clone this wiki locally