Aller au contenu
Sections de la documentation

Identifiants d'API

L'onglet API Credentials de la page Developers affiche la clé d'API de votre espace de travail. Vos applications, votre ERP ou votre TMS, et l'intégration Salesforce envoient cette clé avec chaque requête à l'API Safecube. Un espace de travail a une seule clé : l'onglet l'affiche, la copie et la remplace.

Qui peut ouvrir API Credentials

GesteRôle minimumPlan
Ouvrir Developers et l'onglet API CredentialsAdminTous les plans
Afficher et copier la cléAdminTous les plans
Renouveler la cléAdminTous les plans

Un Editor ou un Viewer ne voit pas Developers dans la barre latérale, et un lien vers /api/credentials le mène à la page d'accès refusé. Les rôles sont décrits dans Utilisateurs et rôles.

Ouvrir API Credentials

  1. Sélectionnez Developers dans la barre latérale. Quand la barre latérale est repliée, son icône indique API Access.
  2. La page s'ouvre sur l'onglet API Credentials. L'onglet Webhooks voisin est décrit dans Console des webhooks.

L'adresse https://app.safecube.ai/api/credentials ouvre directement l'onglet, et toute autre adresse sous /api y mène. Quand la clé ne peut pas être chargée, le toast « Failed to retrieve API credentials. Please try again later. » s'affiche et l'app montre une page d'erreur.

Afficher et copier la clé

La carte API Key indique « This key must be kept confidential ». La clé est masquée par défaut.

  1. Sélectionnez le bouton en forme d'œil, Display key, pour afficher la clé en clair. Sélectionnez-le de nouveau pour la masquer.
  2. Sélectionnez Copy key pour copier la clé dans le presse-papiers. Le bouton copie la clé entière même quand elle est masquée, et n'affiche aucun message de confirmation.

La clé donne accès aux données de tout votre espace de travail. Gardez-la sur vos serveurs, jamais dans une page web, un document partagé ou un dépôt de code public.

Renouveler la clé

Le renouvellement remplace la clé par une nouvelle. La clé actuelle est invalidée aussitôt, sans délai de grâce : toute application, tout script ou toute intégration qui l'envoie encore, Salesforce compris, cesse de fonctionner jusqu'à ce que vous lui donniez la nouvelle clé. Les webhooks déjà configurés continuent de livrer leurs events.

  1. Sélectionnez Rotate API key.
  2. La boîte de dialogue Warning: API Key Rotation indique « This action is irreversible. Your current API key will be permanently invalidated and any application still using it will stop working immediately. ».
  3. Sélectionnez Rotate pour confirmer, ou Cancel pour garder la clé actuelle.

En cas de succès, la boîte de dialogue se ferme, le toast « Your API key has been rotated successfully. » s'affiche et la carte montre la nouvelle clé. Copiez-la et mettez à jour chaque application qui utilisait l'ancienne.

En cas d'échec, le toast « Failed to rotate API key. Please try again later. » s'affiche et la boîte de dialogue montre Server error avec Retry. La clé actuelle reste valide.

Utiliser la clé

L'onglet ne teste pas la clé. La façon de l'envoyer avec une requête, dans l'en-tête API_KEY, est décrite dans le guide Authentification de la documentation de l'API. Les cartes Reference documentation et Quick start guide de l'onglet ouvrent la documentation de l'API dans un nouvel onglet.

Des réponses courtes aux questions fréquentes sur l'API, comme la limite de requêtes ou le choix entre polling et webhooks, sont dans la FAQ API et intégration.

Limites

  • Un espace de travail a une seule clé : l'onglet ne crée pas de deuxième clé, ne nomme pas une clé et n'affiche pas sa date de création.
  • L'onglet ne garde aucun historique des clés précédentes, et une clé renouvelée ne peut pas être restaurée.
  • Le renouvellement ne met pas à jour la clé dans vos applications ni dans Salesforce : collez-y vous-même la nouvelle clé.