Pular para o conteúdo principal
PDGRH

API Développeurs Admin

Intégrez Kaltiv avec vos outils existants via l'API REST publique.

Documentation complète

La documentation technique détaillée est disponible à l'adresse :

/developer/api-docs — Référence complète des endpoints, authentification et exemples (accessible depuis le SaaS).

Clés API

Créer une clé

  1. Menu latéral → ParamètresClés API (/settings/api-keys)
  2. Cliquez sur Nouvelle clé
  3. Donnez un nom descriptif (ex: « Intégration comptable »)
  4. Sélectionnez les scopes (permissions) nécessaires
  5. Définissez la limite de requêtes par minute
  6. Cliquez sur Créer la clé
Important

La clé complète n'est affichée qu'une seule fois à la création. Copiez-la immédiatement et stockez-la en lieu sûr.

Scopes disponibles

ScopeDescriptionMéthodes
employees:readLire les données employésGET
products:readLire le catalogue produitsGET
orders:readLire les commandesGET
orders:writeCréer/modifier des commandesGET, POST, PUT
invoices:readLire les facturesGET
customers:readLire les données clientsGET
agriculture:readLire les données agricolesGET

Révoquer une clé

  1. Allez dans ParamètresClés API
  2. Cliquez sur l'icône de suppression (🗑️) de la clé concernée
  3. Confirmez la révocation

La clé est immédiatement désactivée. Les intégrations qui l'utilisent cesseront de fonctionner.

Authentification

Incluez votre clé dans l'en-tête HTTP de chaque requête :

Authorization: Bearer tk_votre_cle_ici

Limites de requêtes

  • Par défaut : 100 requêtes/minute par clé
  • Configurable : 1 à 1 000 requêtes/minute
  • Les en-têtes de réponse indiquent votre consommation : X-RateLimit-Remaining

Cas d'usage courants

IntégrationScopes nécessaires
Logiciel comptableinvoices:read, orders:read
Site e-commerceproducts:read, orders:write, customers:read
Tableau de bord BIemployees:read, agriculture:read
Application mobileorders:read, customers:read
Format des réponses

Toutes les réponses sont au format JSON. Les listes sont paginées avec les paramètres page et per_page. Les erreurs suivent le format standard HTTP (400, 401, 403, 404, 429, 500).