Getting Started
API Keys

API Keys

Every TrackLogy workspace has a single auto-managed API key. This key authenticates all API requests you make on behalf of your workspace.

Where to Find Your API Key

  1. Log in to my.tracklogy.com (opens in a new tab)
  2. Click your profile or workspace name in the top-right corner
  3. Navigate to Settings → API Keys

Your key is displayed there. It looks like:

tlk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Using Your API Key

All API requests must include your key as a Bearer token in the Authorization header:

curl https://api.tracklogy.com/v1/shipments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

In JavaScript / Node.js:

const response = await fetch('https://api.tracklogy.com/v1/shipments', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
})
const data = await response.json()
⚠️

Never hardcode your API key directly in source code. Use environment variables:

# .env
TRACKLOGY_API_KEY=tlk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Then reference it as process.env.TRACKLOGY_API_KEY in Node.js or equivalent in your language.

Key Rotation

If you believe your API key has been compromised:

  1. Go to Settings → API Keys in the dashboard
  2. Click Regenerate Key
  3. Update your environment variables and any deployed services with the new key

The old key is immediately invalidated upon regeneration.

Security Tips

  • Store your API key in environment variables, not in code
  • Do not commit .env files to version control — add them to .gitignore
  • Never expose your API key in client-side JavaScript or mobile apps
  • Use a secrets manager (AWS Secrets Manager, Vault, etc.) in production environments
  • Rotate your key periodically as a security hygiene practice

Team Members

If your workspace has team members, all members share the same workspace API key. Manage team access from Settings → Team in the dashboard.