Tags

A tag is the dynamic NFC identity bound to a physical item. You provision tags under an account; later, each tag is written onto a physical chip and, once in the field, scanned to produce verifications.

Fields

A tag also carries a lifecycle status that advances as the tag is manufactured:

A tag can only be verified once it reaches configured — before that it has no chip behind it, so a scan against it returns 404 (see Verifications).

The protocol attribute

protocol selects which tag protocol the chip uses. The currently supported values are:

Use the identifier (left column) as the protocol value. Any other value is rejected with 422. The examples below show it as "<protocol>" — substitute one of the identifiers above (e.g. "ntag_424_dna").

Create tags

POST /api/v1/tags

Tags are created in a batch under the account whose key you present.

Request

{
  "data": {
    "type": "tags",
    "attributes": {
      "protocol": "<protocol>",
      "count": 50
    }
  }
}

curl https://platform.tagbase.io/api/v1/tags \
  -X POST \
  -H "Authorization: Bearer $TAGBASE_API_KEY" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{ "data": { "type": "tags", "attributes": { "protocol": "<protocol>", "count": 50 } } }'

const res = await fetch("https://platform.tagbase.io/api/v1/tags", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TAGBASE_API_KEY}`,
    "Content-Type": "application/vnd.api+json",
  },
  body: JSON.stringify({
    data: { type: "tags", attributes: { protocol: "<protocol>", count: 50 } },
  }),
});
const tags = (await res.json()).data;

$response = $client->post("https://platform.tagbase.io/api/v1/tags", [
    "headers" => [
        "Authorization" => "Bearer " . getenv("TAGBASE_API_KEY"),
        "Content-Type"  => "application/vnd.api+json",
    ],
    "json" => [
        "data" => ["type" => "tags", "attributes" => ["protocol" => "<protocol>", "count" => 50]],
    ],
]);
$tags = json_decode((string) $response->getBody(), true)["data"];

tags =
  Req.post!("https://platform.tagbase.io/api/v1/tags",
    headers: [
      {"authorization", "Bearer #{System.fetch_env!("TAGBASE_API_KEY")}"},
      {"content-type", "application/vnd.api+json"}
    ],
    json: %{data: %{type: "tags", attributes: %{protocol: "<protocol>", count: 50}}}
  ).body["data"]

Response — 201 Created

A JSON:API array of the created tags. Each entry is a tags resource id; the ids are what you store and later reference when verifying scans.

{
  "data": [
    { "type": "tags", "id": "tag_abcdef0123456789" },
    { "type": "tags", "id": "tag_0123456789abcdef" }
  ]
}

Tags are returned in created status. Writing them onto physical chips happens out of band; your integration holds the ids in the meantime.

Errors

Notes

• There is no endpoint to list or read tags after creation. Persist the returned ids when you create the batch.
• Tags belong to the account whose key created them. To keep tenants isolated, create each tenant’s tags with that tenant’s subaccount key.