Pour: Administrateurs
Authentifiez les requêtes API avec une clé
Envoyez votre clé sous forme de jeton porteur à l'API du panneau d'administration pour une clé de gestion ou à l'API du portail pour une clé de hub, et limitez-la à vos adresses IP.
Dans cet article5 sections
Avant de commencer
Cette page indique où envoyer chaque type de données. Clé APIClé Un jeton secret, créé dans la section Intégration, qui permet à votre propre logiciel d'utiliser l'API du hub., Comment l’envoyer, et pourquoi une clé est refusée.
Adresses
| Clé | Adresse de base | Exemple |
|---|---|---|
| Gérer les éléments clés | https://prd-api-manage.caseactive.com/v1/<hub id>/ | https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases |
| Gérer les importations clés. | https://prd-api-manage.caseactive.com/v1/integration/<hub id>/ | https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports |
| Clé Hub | https://prd-api-app.caseactive.com/v1/<hub id>/ | https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases |
| Clé Hub, un seul cas. | https://prd-api-app.caseactive.com/v1/<hub id>/<case id>/ | https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts |
Votre ID de hub est : ca- Et 14 caractères au total. Il s’affiche comme suit : Identifiant du hub sur Aperçu Sur votre portail, il y a une page dédiée à chaque cas, avec un bouton pour en copier une copie. L’identifiant du cas est… cc- Et 14 caractères, indiqués comme suit : Identifiant du cas.
Envoi de la clé
Envoyer la clé dans le champ Authorization de chaque appel, après Bearer et un espace.
curl https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles \
-H "Authorization: Bearer YOUR_API_KEY"
- Envoyer des corps JSON avec
Content-Type: application/json. - Une clé ne se détériore pas avec le temps. Elle reste valable tant que quelqu’un d’autre ne l’active pas ou ne la supprime pas dans la section Intégration › Clés.
- Tous les signaux sont reçus de nouveau : il n’y a pas de session ou de jeton à échanger.
- Les dates et les heures sont indiquées en UTC.
Limiter son utilisation
Sous CIDR source, une clé peut être limitée à l’adresse IPv4 publique de votre système, comme 203.0.113.10, ou à un ensemble d’adresses, comme 203.0.113.0/24. L’API ne prend en compte que les connexions IPv4. Par conséquent, toute adresse ou ensemble d’adresses IPv6 sera rejeté lors de la sauvegarde. Toute demande provenant d’un autre endroit sera rejetée avec l’erreur 401 LoginSourceIpException. Pour changer l’ensemble d’adresses, veuillez consulter Restreindre ou annuler une clé API.
Lorsqu'une clé est refusée
Toute refusée est en réalité un corps d’erreur, dont les noms message indiquent la nature de l’erreur. Voir Gestion des erreurs et codes d’état de l’API.
| Statut | message | Pourquoi | Ce qu'il faut faire |
|---|---|---|---|
| 401 | Unauthorized | Aucun mot de passe n’a été envoyé, ou ce qui a été envoyé n’est pas un mot de passe. | Vérifiez le header Authorization. |
| 401 | HostNotFoundException | L’ID du hub mentionné dans l’adresse n’existe pas. | Copier à nouveau Identifiant du hub. |
| 401 | HostPurgingException | Le hub est en train d’être supprimé. | Demandez à un administrateur de votre hub. |
| 401 | SessionNotFoundException | La clé a été supprimée, ou appartient à un autre hub. | Utilisez une clé actuelle pour ce hub. |
| 401 | LoginKeyInactiveException | L’interrupteur est éteint. | Demandez à un administrateur de l’activer. |
| 401 | LoginKeyWrongApiException | Une clé de gestion a été envoyée à l’adresse de la clé du hub, ou vice versa. | Utilisez l’adresse correspondant au type de clé. |
| 401 | LoginSourceIpException | L’appel provenait en dehors de la portée du clé. | Appeler depuis une adresse autorisée, ou élargir la portée de l’appel. |
| 401 | LoginSourceCidrException | La zone où se trouve la clé ne peut être lue. | Corrigé : CIDR source |
| 403 | BotNotAllowedException | Gérer une clé qui ne peut être utilisée. | Voir Comprendre ce que la API peut faire. |
| 403 | ManageBillingInactiveException | Le panneau d’administration de votre hôte est verrouillé après un échec de paiement. Vous pouvez uniquement gérer les clés nécessaires pour accéder au panneau d’administration. | Demandez à un administrateur de mettre à jour la méthode de paiement. |
| 403 | BillingReadOnlyException | La souscription de votre hub est terminée, et son portail est uniquement destiné à la lecture. Par conséquent, une clé hub ne peut rien modifier sur le portail lui-même. | Demandez à un administrateur de redémarrer la souscription. |
| 403 | CaseClosedException | Un hub key a essayé de changer une situation fermée. | Ouvrez d’abord le cas. |
| 404 | CaseNotFoundException | Un mot de passe correspondant à un nom de cas qui n’existe pas, ou qui ne se trouve pas dans votre hub. | Vérifiez l’identifiant du cas. |
| 503 | LoginSessionException | Le centre de contrôle était trop occupé pour pouvoir vérifier cette clé. | Revenez bientôt pour essayer à nouveau. |
Un code 401 signifie toujours que la clé elle-même a été refusée. Ainsi, une synchronisation peut s’interrompre, ce qui peut alerter quelqu’un. Les autres erreurs concernent plutôt le processus de communication entre les appareils.