Pour: Administrateurs
Comprendre les possibilités de l'API
Découvrez ce que permettent chacune une clé de gestion et une clé de hub, pourquoi chaque clé agit comme un assistant virtuel et où trouver la liste technique complète.
Dans cet article2 sections
L’API permet à votre propre logiciel, comme un système de gestion de cas, de fonctionner avec votre hub, sans que personne ne soit obligé d’utiliser les écrans. Cet API est appelé via une clé APIClé Un jeton secret, créé dans la section Intégration, qui permet à votre propre logiciel d'utiliser l'API du hub.. Il existe deux types de clés : une clé de gestion, destinée au panel administratif, pour gérer des cas et des personnes ; et une clé Hub, destinée au fonctionnement interne des cas.
Comment ça marche
Deux clés, deux API. Chaque type de clé correspond à son propre adresse, suivie de l’ID de votre hub. Ces clés sont rejetées par l’autre partie.
| Clé | Adresse | Ce qu'il atteint |
|---|---|---|
| Gérer les éléments clés | https://prd-api-manage.caseactive.com/v1/<hub id>/ | Il s’agit de cas, de personnes impliquées dans ces cas, de leurs accès, de leurs rôles, des étapes du processus, ainsi que des factures à consulter. Les importations sont en cours à https://prd-api-manage.caseactive.com/v1/integration/<hub id>/. |
| Clé Hub | https://prd-api-app.caseactive.com/v1/<hub id>/ | Tout ce qui se trouve dans chaque dossier : les publications et commentaires, les fichiers, les formulaires, les signes électroniques, les tâches, les factures, les événements, les notes, ainsi que les détails concernant le dossier en question. |
Quelle fonction incroyable que celle d’une clé de gestion ! Seuls ceux-ci. Toute autre demande faite via l’API du panier administratif entraînera une réponse 403. BotNotAllowedException.
- Cas : liste, création, lecture, mise à jour et suppression. Voir Créer et mettre à jour les cas, avec la fonction de gestion des clés.
- Membres de l’ensemble : liste, ajout et suppression. Voir Ajouter et supprimer des membres de l’ensemble avec une clé de gestion.
- Personnes : ajouter, lire, désactiver ou réactiver des personnes. Voir Ajouter et mettre à jour les utilisateurs avec une clé de gestion.
- Rôles et étapes : lisez les informations correspondantes. Veuillez consulter Les rôles à lire, avec la clé “manage”.
- Champs personnalisés : lisez les pages relatives aux champs de cas et d’utilisateurs. Consultez la section Création et mise à jour des cas avec une clé de gestion.
- Factures : lisez-les. Veuillez consulter la section Comment lire les factures avec une clé de gestion.
- Rechercher. Voir Rechercher des cas et des utilisateurs qui possèdent une clé de gestion.
- Importations. Voir Exécuter une importation avec la touche ‘manage’.
Chaque clé représente votre assistante virtuelle. Des signes clés qui indiquent que votre centre est en bon état. Assistante virtuelleAssistant virtuel Un membre d'équipe automatisé qui publie des messages de bienvenue, des enregistrements et des publications pour l'entreprise ; ses publications portent un badge d'assistant virtuel.. Ce que l’assistant virtuel publie est indiqué sous son nom et son badge. Les modifications apportées sont également enregistrées comme étant effectuées par l’assistant virtuel. L’assistant virtuel est présent dans chaque cas, de sorte qu’une clé de hub permet d’accéder à tous les cas concernés. Il peut effectuer toutes les tâches autorisées par le rôle de l’assistant virtuel. En outre, un cas fermé ne lui est accessible qu’en mode lecture seule. Une clé de hub ne peut pas créer de nouveaux cas, ajouter ou retirer des personnes, payer des factures, ni ouvrir ou répondre à des demandes.
Les clés ne s’éteignent pas avec le temps. C’est un élément essentiel qui reste en place jusqu’à ce qu’un administrateur le désactive ou le supprime. Limitez chaque élément à l’adresse IPv4 publique de votre système. Voir… Restreindre ou annuler une clé API.
Les pages techniques. Chaque API publie une liste détaillée de ses appels, sans qu’il soit nécessaire de s’inscrire avant de pouvoir utiliser ces informations.
| Gérer la clé | Clé de hub | |
|---|---|---|
| Interactif (Swagger UI) | https://prd-api-manage.caseactive.com/ | https://prd-api-app.caseactive.com/ |
| Référence (ReDoc) | https://prd-api-manage.caseactive.com/redoc | https://prd-api-app.caseactive.com/redoc |
| Document OpenAPI | https://prd-api-manage.caseactive.com/openapi.json | https://prd-api-app.caseactive.com/openapi.json |
Les applications indiquent toutes les appels qu’elles effectuent elles-mêmes, y compris de nombreux appels que la clé de gestion ne peut pas gérer. La liste ci-dessus indique ce que la clé de gestion peut utiliser pour gérer ces appels. Pour essayer un appel sur la page interactive, sélectionnez Autoriser et collez votre clé.
Un hub verrouillé. Lorsque le panneau d’administration de votre hôte est verrouillé après un échec de paiement, une tentative de modification est refusée, avec l’erreur 403. ManageBillingInactiveException. Une clé Hub continue de fonctionner jusqu’à ce que le portail devienne uniquement consultable : 14 jours après un paiement échoué, si celui-ci n’a toujours pas été effectué, ou le jour où une abonnement annulé prend fin. À partir de then, la clé Hub peut toujours être utilisée pour lire les données, mais tout changement apporté est refusé, avec l’erreur 403. BillingReadOnlyException, Jusqu’à ce que l’administrateur redémarre la souscription.
Quand l'utiliser
Utilisez une clé de gestion pour maintenir votre système à jour par rapport à un autre système : créez des dossiers, ajoutez des clients auxdits dossiers, retirez l’accès des utilisateurs lorsqu’ils quittent le système, ou chargez plusieurs lignes d’informations d’un fichier en même temps. Utilisez également une clé de gestion pour travailler directement dans les dossiers, par exemple pour ajouter des informations lorsque quelque chose change dans votre système.
Pour être informé des changements qui se produisent dans votre hub, plutôt que d’avoir à les demander directement, utilisez un webhook. Voir ici. Créez un webhook.. Pour créer une clé, veuillez consulter la documentation correspondante. Créer une clé API..