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"]

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

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_...",
})

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

import requests

headers = {
    "Authorization": "Bearer tk_live_abc123..."
}

# 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']}")

const API_KEY = process.env.KNOXCALL_API_KEY;

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

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

<?php

$apiKey = getenv('KNOXCALL_API_KEY');

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

$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_API_KEY="tk_live_abc123..."

# Or use a .env file with dotenv
echo 'KNOXCALL_API_KEY=tk_live_abc123...' >> .env

# Set for current session
$env:KNOXCALL_API_KEY = "tk_live_abc123..."

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

services:
  app:
    environment:
      - KNOXCALL_API_KEY=tk_live_abc123...
    # Or reference a .env file
    env_file:
      - .env

# Store as a repository secret, then reference in workflow:
env:
  KNOXCALL_API_KEY: ${{ secrets.KNOXCALL_API_KEY }}