Klantly Developers

Référence de l'API

Clé API

Testez votre connexion et voyez quelle clé, quelle entreprise, quels scopes et quelles limites s'appliquent.

Endpoints

Récupérer la clé et l'entreprise

GET /api/v1/me

Renvoie la clé avec laquelle vous faites la requête, avec l'entreprise, les scopes, la date d'expiration et les limites. Utilisez cet endpoint pour tester votre connexion : il ne requiert aucun scope.

Scope
Aucun scope requis : toute clé valide.

Exemple de requête

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

Réponse 200

Exemple de réponse
{
  "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
      }
    ]
  }
}

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

L'objet

Tous les champs sont toujours présents ; un champ sans valeur vaut null.

ChampTypeDescription
object string Toujours « api_key ».
id string Id de la clé.
name string Le nom donné à la clé dans Klantly.
prefix string Le début de la clé, pour la reconnaître.
scopes array<string> Les scopes de la clé.
expires_at string (date-time) Date d'expiration, ou null si la clé n'expire pas. peut être vide (null)
created_at string (date-time) Créée le (UTC).
company object L'entreprise à laquelle appartient la clé.
company.object string Toujours « company ».
company.id string Id de l'entreprise.
company.name string Nom de l'entreprise.
rate_limits array<object> Les limites qui s'appliquent à cette clé.
rate_limits.name string Nom de la limite.
rate_limits.limit integer Nombre maximal de requêtes dans la fenêtre.
rate_limits.window_seconds integer Durée de la fenêtre en secondes.