Cet article fournit une vue d'ensemble de ce qui peut être fait avec l'API de Prokeep, comment l'activer et comment la contrôler.
L'API de Prokeep
L'API de Prokeep vous permettra de :
- Communiquer avec les clients en fonction d'un déclencheur activé par votre logiciel tiers.
- Informer un client que sa commande a été placée dans un casier
- Mettre à jour les informations d'expédition d'un client
- Envoyer un accusé de réception après une commande
- Partager vos coordonnées entre Prokeep et votre logiciel tiers, tel que votre CRM ou votre ERP.
Pour une documentation complète sur les fonctions disponibles de l'API, consultez la documentation technique.
Générer les informations d'identification de l'API :
Les identifiants API sont distincts de vos identifiants de connexion à Prokeep.
Un administrateur Prokeep de votre compte devra créer un ensemble de crédentiels génériques pour accéder à notre API Ces informations d’identification se créent et se gèrent sous Paramètres.
- Dans Paramètres, cliquez sur
- Sur la page API, cliquez sur Créer une application. Lorsque vous y êtes invité, donnez à votre application un Vous pouvez créer autant d'applications que vous le souhaitez, et il est fortement recommandé de créer une application pour chaque système externe qui appellera l'API Prokeep.
- Une fois votre application créée, cliquez sur Générer des informations d'identification. Copiez le nom d'utilisateur et le mot de passe fournis, et cliquez sur Nous n'affichons plus le mot de passe une fois que les informations d'identification ont été confirmées ; veillez donc à l'enregistrer ailleurs avant de le faire. L'API de Prokeep utilise une authentification de base.
- Les informations d'identification ne sont pas actives tant que l'administrateur n'a pas cliqué sur confirmer
- Si vous perdez les informations d'identification après les avoir confirmées, vous pouvez les régénérer en cliquant sur Révoquer les informations d'identification. Cela vous donnera la possibilité de générer de nouveaux accès pour cette application API
- Vous pouvez renommer vos applications en cliquant simplement sur le nom de l'application.
Remarque : Les actions menées par l'API dans Prokeep seront rattachées à cette application pour des raisons de reporting
Surveillance de l'API :
Une fois que vous avez généré les informations d'identification pour l'application, vous remarquerez un nouveau bouton pour cette application qui se lit comme suit : Ouvrir les journaux de l'API. En cliquant sur ce bouton, vous accéderez à la page du journal de l'API. À cet endroit, vous pouvez voir un enregistrement de tous les événements API et webhook associés à cette application, ainsi que leur statut : succès, échecs et les codes indiquant les erreurs survenues.
Rapports de messages générés par l’API :
Si vous voulez simplement consulter une liste des contacts ayant reçu un message texte ou un e-mail de l'API, vous pouvez télécharger une liste détaillée avec notre Export de Rapports. Une fois l'API activée pour votre compte, vous verrez un onglet API dans votre exportation de rapports. Cet onglet contient une liste de tous les messages envoyés au cours de la période couverte par le rapport, de leurs destinataires et de l'application qui les a envoyés.
Pour plus d'informations sur la création de rapports récurrents, cliquez ici.