Klantly Developers

API-Referenz

API-Schlüssel

Testen Sie Ihre Verbindung und sehen Sie, welcher Schlüssel, welches Unternehmen, welche Scopes und welche Limits gelten.

Endpunkte

Schlüssel und Unternehmen abrufen

GET /api/v1/me

Gibt den Schlüssel zurück, mit dem Sie die Anfrage stellen, samt Unternehmen, Scopes, Ablaufdatum und Limits. Nutzen Sie diesen Endpunkt, um Ihre Verbindung zu testen: Er erfordert keinen Scope.

Scope
Kein Scope nötig: jeder gültige Schlüssel.

Beispielanfrage

cURL
curl "https://app.klantly.com/api/v1/me" \
  -H "Authorization: Bearer $KLANTLY_API_KEY"
PHP
$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('GET', 'me');

$data = json_decode((string) $response->getBody(), true)['data'];
JavaScript
const response = await fetch('https://app.klantly.com/api/v1/me', {
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
  },
});

const { data } = await response.json();
Python
import os

import requests

response = requests.get(
    "https://app.klantly.com/api/v1/me",
    headers={
        "Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
    },
)
data = response.json()["data"]

Antwort 200

Beispielantwort
{
  "data": {
    "object": "api_key",
    "id": "01j7zq3k9x2m4n6p8r0t2v4w6y",
    "name": "Website",
    "prefix": "kly_4fZ2mQ8v",
    "scopes": [
      "customers.read",
      "customers.write"
    ],
    "expires_at": "2027-09-14T10:15:00Z",
    "created_at": "2026-09-14T10:15:00Z",
    "company": {
      "object": "company",
      "id": "42",
      "name": "De Vries Bouw"
    },
    "rate_limits": [
      {
        "name": "key_minute",
        "limit": 120,
        "window_seconds": 60
      }
    ]
  }
}

Zusätzlich kann jeder Endpunkt die allgemeinen Fehler zurückgeben, etwa einen ungültigen Schlüssel oder ein erreichtes Limit. Alle Fehlercodes ansehen.

Das Objekt

Alle Felder sind immer vorhanden; ein Feld ohne Wert ist null.

FeldTypBeschreibung
object string Immer „api_key“.
id string ID des Schlüssels.
name string Der Name, den der Schlüssel in Klantly erhalten hat.
prefix string Der Anfang des Schlüssels, um ihn zu erkennen.
scopes array<string> Die Scopes des Schlüssels.
expires_at string (date-time) Ablaufdatum, oder null, wenn der Schlüssel nicht abläuft. kann leer sein (null)
created_at string (date-time) Erstellt am (UTC).
company object Das Unternehmen, zu dem der Schlüssel gehört.
company.object string Immer „company“.
company.id string ID des Unternehmens.
company.name string Name des Unternehmens.
rate_limits array<object> Die Limits, die für diesen Schlüssel gelten.
rate_limits.name string Name des Limits.
rate_limits.limit integer Höchstzahl der Anfragen im Zeitfenster.
rate_limits.window_seconds integer Länge des Zeitfensters in Sekunden.