Skava Skava / Wiki

Éléments personnalisés : API

Une interface API est un formulaire dont les valeurs remplies Skava envoie en JSON à une adresse que vous spécifiez (votre back-end). De cette façon, vous pouvez connecter Skava en toute sécurité avec vos propres systèmes.

i

Vous gérez les interfaces API dans l'application web sous Éléments personnalisés → basculez Interfaces API. La création et la modification sont réservées aux administrateurs d'entreprise ; les interfaces publiées peuvent ensuite être déclenchées par tous les membres de l'entreprise.

Configurer une interface API

Une interface se compose de champs de saisie (ils forment le JSON), l'adresse cible et l'authentification.

  1. Créer des champs : Chaque champ reçoit une clé JSON. À droite, vous voyez en direct l'aperçu JSON, qui est envoyé à votre back-end exactement de cette manière.
  2. Adresse (URL) : l'adresse https:// de votre back-end. Seules les adresses HTTPS et accessibles publiquement sont autorisées (voir Sécurité ci-dessous).
  3. Méthode : POST (par défaut), PUT, PATCH ou GET. Avec GET, les valeurs sont ajoutées en tant que paramètres de requête au lieu d'être envoyées dans le corps.
  4. Authentification : Définissez le nom d'en-tête (par ex. Authorization) et le préfixe de valeur (par ex. Bearer ), puis sauvegardez le jeton. Définissez optionnellement une date d'expiration.
  5. Champs de réponse (facultatif) : Définissez par chemin quelles valeurs de la réponse du back-end doivent être affichées — par ex. order.id ou items[0].sku.
  6. Vérifiez avec Ping et Requête test, puis Publier.

Stocker le jeton en toute sécurité

Le jeton est stocké chiffré et jamais renvoyé aux clients — l'application affiche uniquement si un jeton est défini et quand il expire. À l'envoi, Skava l'ajoute côté serveur à l'en-tête configuré. Si vous définissez une date d'expiration, Skava refuse l'appel après expiration et vous demande de renouveler le jeton.

Test : Ping et requête test

  • Ping — une vérification légère de la accessibilité. Il ne vérifie que si votre adresse répond et ne envoie pas le jeton ou les données de formulaire dans le processus. Affiche l'accessibilité, le statut et le temps de réponse. Idéal comme première étape.
  • Requête test — le véritable essai : envoie les données d'exemple y compris le jeton à votre adresse et vous affiche la réponse complète ainsi que les champs de réponse extraits.

En tant qu'admin, vous pouvez exécuter les deux encore en mode brouillon pour vérifier l'intégration avant la publication.

Brouillon et publication

Chaque interface commence comme un brouillon et peut être modifiée librement. Une fois que tout est prêt, vous le publiez avec Publier.

!

Les interfaces publiées sont immuables. C'est intentionnel : afin qu'après la publication, personne ne puisse secrètement échanger l'adresse cible ou le jeton. Si vous voulez changer quelque chose, créez une nouvelle version.

Sécurité

i

Pour éviter que l'interface soit utilisée à mauvais escient, des règles strictes s'appliquent : seules les adresses HTTPS sont autorisées et l'adresse doit pointer vers une adresse cible publique — les adresses internes (par ex. localhost, réseaux privés ou métadonnées cloud) sont rejetées. Skava vérifie cela à chaque appel, se connecte exactement à l'adresse vérifiée, ne suit pas les redirections et limite le délai d'attente et la taille de réponse.

Liens connexes

Vous voulez plutôt créer un modèle de document remplissable ? Voir Éléments personnalisés : Documents.

Questions fréquemment posées

Qu'est-ce qu'une interface API dans Skava ?

Un formulaire dont les valeurs remplies Skava envoie en JSON à une adresse que vous spécifiez (votre back-end) — pratique pour connecter Skava à vos propres systèmes.

Qui est autorisé à créer et déclencher les interfaces API ?

La création et la modification sont réservées aux administrateurs d'entreprise. Une interface publiée peut ensuite être déclenchée par tous les membres de l'entreprise.

Quelle est la différence entre « Ping » et « Requête test » ?

Ping vérifie uniquement si l'adresse est accessible — sans jeton et sans données. Requête test envoie les données d'exemple y compris le jeton et affiche la réponse complète.

Mon jeton API est-il sécurisé ?

Oui. Le jeton est stocké chiffré et jamais livré aux clients. L'application affiche uniquement si un jeton est défini et quand il expire.

Quelles adresses sont autorisées en tant que points de terminaison ?

Seules les adresses https:// accessibles publiquement. Les cibles internes comme localhost, réseaux privés ou métadonnées cloud sont rejetées — cela protège contre l'utilisation abusive de l'interface.

Pourquoi ne peux-je plus modifier une interface publiée ?

Les interfaces publiées sont intentionnellement immuables — afin qu'après la publication, personne ne puisse échanger l'adresse cible ou le jeton. Pour les modifications, vous créez une nouvelle version.