POST
/
v1
/
url-groups
curl --request POST \
  --url https://third-party.etrnl.app/v1/url-groups \
  --header 'API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "customUrl": "<string>",
  "appName": "<string>"
}'
{
	success: true,
	err: '',
	group: {
		name: "New Group",
		appName: "ETRNL",
        organizationId: 33,
        creationDate: "2023-09-26T18:44:59.000Z",
		customUrl: "https://example.com/{tagId}/?enc={enc}&cmac={cmac}&eCode={eCode}"
	}
}

This endpoint can be used to create a new URL configuration that can then be programmed into multiple tags.

Defining the URL

A custom URL can be defined by writing out your URL and wrapping 4 of the required parameters in curly braces ”{}“.

Custom URL Params

  • tagId - The ETRNL unique ID of the tag
  • enc - The encrypted message generated by the tag
  • cmac - he CMAC integrity data generated by the tag (Only required if tamper detection is not enabled)
  • tt - The encrypted tag tamper status generated by the tag. (Only required if tamper detection is enabled)
  • eCode - A KDF input parameter used for key decyrption

Examples

  • Custom URL

  • Tag generated URL

https://exmaple.com/{tagId}/?enc={enc}&cmac={cmac}&eCode={eCode}


The custom URL params can only be used as a query parameter, or a URL slug.

Tag Tamper

For tag tamper URLs, you cannot include the cmac value as the tt message includes both the cmac and the encrypted tamper status.

So the custom URL would look something like:

https://exmaple.com/{tagId}/?enc={enc}&tt={tt}&eCode={eCode}

Headers

API-Key
string
required

Your organization’s private API key.

JSON Request Body

name
string
required

The name of your custom URL group.

customUrl
string
required

The custom URL definition that will be programmed into the tags.

appName
string
required

This is the service that’s used to add the custom URL. The custom URL group will show up in the programmer as [APP Name] - Name.