Références API
Génération de clés API
Cet article vous montre comment générer ou trouver vos identifiants API (existants) - c'est le même processus pour les comptes de test et les comptes en direct.
Note
Les tests et les identifiants API en direct se trouvent sous soit votre compte de test, soit votre compte en direct. Pour utiliser votre clé d'API privée pour des transactions en direct, copiez-la à partir de votre compte en direct. Il en va de même pour les transactions de test. Dans ce cas, vous devez vous connecter à votre compte de test.
Accéder à la page Références API via Développeurs > Références API .
Clé privée d'API:
Soit vous trouvez votre clé privée existante dans la liste.
Ou vous cliquez sur Générer un nouveau afin de créer une nouvelle clé privée.
Clé publique d'API: Cliquez sur Utilisez des clés publiques pour identifier votre compte lorsque vous utilisez le jeton Billwerk+ pour afficher votre clé publique.
Soit vous trouvez votre clé publique existante dans la liste.
Ou vous cliquez sur Générer un nouveau afin de créer une nouvelle clé privée.
Erreurs API
Lorsque vous utilisez notre API des erreurs peuvent se produire, découvrez ce qu'elles signifient ici.
Erreurs HTTPS
La principale façon dont l'API indique qu'une erreur s'est produite consiste à renvoyer un code d'état HTTP.
les codes dans la plage 2xx indiquent un succès
les codes dans la plage 4xx indiquent une erreur qui résulte des informations fournies
Les codes de la série 5xx indiquent une erreur au niveau de Billwerk+ ou des systèmes externes utilisés par Billwerk+.
200- OK Tout a fonctionné comme prévu.
400- Demande incorrecte opération illégale sur une ressource.
401- Non autorisé Aucune authentification valide fournie
403- Authentification interdite donnée mais non autorisée à opérer sur des ressources.
404- La ressource demandée ou les ressources référencées n'ont pas pu être trouvées.
405- Méthode non autorisée La méthode HTTP utilisée n'est pas autorisée sur la ressource.
422- Entité non traitable La requête n'a pas pu être interprétée, il manque souvent un paramètre requis ou des paramètres mal formatés, par exemple un JSON mal formaté.
500 - 504 - Erreurs de serveur Une erreur interne s'est produite du côté de Billwerk+.
Réponse d'erreur
Toutes les réponses 2xx qui n'aboutissent pas renvoient une réponse d'erreur générique JSON avec les paramètres suivants.