Authentication

npm install @knoxcall/sdk

import { KnoxCall } from "@knoxcall/sdk";

const client = new KnoxCall({ tenant: "acme" });
const routes = await client.routes.list();

from knoxcall import KnoxCall

# Credentials from KNOXCALL_CLIENT_ID / KNOXCALL_CLIENT_SECRET
client = KnoxCall()
page = client.routes.list()
routes = page["data"]

client, err := knoxcall.New(knoxcall.Options{})
if err != nil {
    log.Fatal(err)
}
page, err := client.Routes.List(context.Background(), nil)
// page.Data holds the routes

$client = new KnoxCall(); // env-configured
$page   = $client->routes->list();
$routes = $page['data'];

client = KnoxCall::Client.new # env-configured
page   = client.routes.list
routes = page["data"]

# Mint a 1-hour OAuth token (client_credentials) — see Quick start above
TOKEN=$(curl -s -X POST https://api.knoxcall.com/oauth/token \
  -u "$KNOXCALL_CLIENT_ID:$KNOXCALL_CLIENT_SECRET" \
  -d "grant_type=client_credentials" | jq -r .access_token)

curl https://api.knoxcall.com/v1/routes \
  -H "Authorization: Bearer $TOKEN"

import { KnoxCall } from "@knoxcall/sdk";

const client = new KnoxCall({
  tenant: "acme",
  sandbox: true, // → https://sandbox.knoxcall.com + https://sandbox-acme.knoxcall.com
});

// Use a tk_test_ key — required for sandbox.

import "github.com/knoxcall/knoxcall-go/knoxcall"

client, err := knoxcall.New(knoxcall.Options{
    Tenant:  "acme",
    Sandbox: true, // → https://sandbox.knoxcall.com + https://sandbox-acme.knoxcall.com
    APIKey:  "tk_test_...",
})

# Mint a 1-hour OAuth token (client_credentials)
TOKEN=$(curl -s -X POST https://api.knoxcall.com/oauth/token \
  -u "$KNOXCALL_CLIENT_ID:$KNOXCALL_CLIENT_SECRET" \
  -d "grant_type=client_credentials" | jq -r .access_token)

curl https://api.knoxcall.com/v1/routes \
  -H "Authorization: Bearer $TOKEN"

import os
import requests

headers = {
    # OAuth access token minted via POST /oauth/token
    "Authorization": f"Bearer {os.environ['KNOXCALL_ACCESS_TOKEN']}"
}

# List all routes
response = requests.get(
    "https://api.knoxcall.com/v1/routes",
    headers=headers
)

routes = response.json()["data"]
for route in routes:
    print(f"{route['name']} - {route['target_base_url']}")

// OAuth access token minted via POST /oauth/token
const TOKEN = process.env.KNOXCALL_ACCESS_TOKEN;

const response = await fetch("https://api.knoxcall.com/v1/routes", {
  headers: {
    Authorization: `Bearer ${TOKEN}`
  }
});

const { data: routes } = await response.json();
routes.forEach(route => {
  console.log(`${route.name} - ${route.target_base_url}`);
});

<?php

// OAuth access token minted via POST /oauth/token
$token = getenv('KNOXCALL_ACCESS_TOKEN');

$ch = curl_init('https://api.knoxcall.com/v1/routes');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer {$token}"
    ]
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
foreach ($data['data'] as $route) {
    echo "{$route['name']} - {$route['target_base_url']}\n";
}

curl https://api.knoxcall.com/v1/routes \
  -H "x-api-key: tk_live_abc123..."

import requests

response = requests.get(
    "https://api.knoxcall.com/v1/routes",
    headers={"x-api-key": "tk_live_abc123..."}
)

const response = await fetch("https://api.knoxcall.com/v1/routes", {
  headers: { "x-api-key": process.env.KNOXCALL_API_KEY }
});

<?php

$ch = curl_init('https://api.knoxcall.com/v1/routes');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "x-api-key: " . getenv('KNOXCALL_API_KEY')
    ]
]);

$response = curl_exec($ch);
curl_close($ch);

# Add to your shell profile (~/.bashrc, ~/.zshrc, etc.)
export KNOXCALL_CLIENT_ID="..."
export KNOXCALL_CLIENT_SECRET="..."

# Or use a .env file with dotenv
echo 'KNOXCALL_CLIENT_ID=...' >> .env
echo 'KNOXCALL_CLIENT_SECRET=...' >> .env

# Legacy long-lived key (still supported)
export KNOXCALL_API_KEY="tk_live_abc123..."

# Set for current session
$env:KNOXCALL_CLIENT_ID = "..."
$env:KNOXCALL_CLIENT_SECRET = "..."

# Set permanently for current user
[System.Environment]::SetEnvironmentVariable("KNOXCALL_CLIENT_ID", "...", "User")
[System.Environment]::SetEnvironmentVariable("KNOXCALL_CLIENT_SECRET", "...", "User")

services:
  app:
    environment:
      - KNOXCALL_CLIENT_ID=...
      - KNOXCALL_CLIENT_SECRET=...
    # Or reference a .env file
    env_file:
      - .env

# Prefer workload identity federation — zero stored secrets (see
# "Workload identity federation" above). Otherwise store the client
# secret as a repository secret and reference it:
env:
  KNOXCALL_CLIENT_ID: ${{ secrets.KNOXCALL_CLIENT_ID }}
  KNOXCALL_CLIENT_SECRET: ${{ secrets.KNOXCALL_CLIENT_SECRET }}