Intégration API KIWIZ
- Guillaume Sanchez
https://www.kiwiz.io/ est une plateforme de certification dans la Blockchain de documents (factures et avoirs).
Pour chaque facture et avoir, vous devez nous envoyer le document PDF et les données associées :
Documentation de l'API : https://api.kiwiz.io/doc#/
API : https://api.kiwiz.io/
Guide étapes par étapes :
Voici les étapes pour la mise en place
- Souscrire à un abonnement Kiwiz
- Récupérer son token d'identification
- Gestion des factures (post & get)
- Gestion des avoirs (post & get)
Vous devez avoir un abonnement actif pour intégrer Kiwiz.
Toutes les offres proposent un essai gratuit de 30 jours sans engagement : https://www.kiwiz.io/prix
1 - Souscrire à un abonnement Kiwiz
Choisissez votre offre sur cette page : https://www.kiwiz.io/prix
Vous recevrez ensuite vos identifiants à l'API Kiwiz par email avec les éléments suivants :
- username
- password
- subscription_id
Le subscription_id permet d'identifier votre système de caisse.
Le subscription_id permet d'identifier votre système de caisse, si vous avez plusieurs caisses, vous devez avoir plusieurs abonnements et donc plusieurs "subscription_id"
Si vous avez par exemple une boutique sous Magento en multi-boutique, vous devez avoir autant de d'abonnements que de boutiques.
N'hésitez pas à nous contacter si vous avez des volumes importants.
2 - Récupérer le token d'identification
Vous devez envoyer vos identifiants à l'API pour récupérer votre token.
Base URL API : https://api.kiwiz.io/
Documentation de l'API https://api.kiwiz.io/doc#/Tokens/authLogin
3 - Gestion des factures
A : Envoyer les factures à l'API
Vous devez envoyer vos factures et données à l'API
Base URL API : https://api.kiwiz.io/
Documentation de l'API https://api.kiwiz.io/doc#/Factures/invoiceSave
- Document : fichier PDF de la facture
- Data : données de la facture
La liste des données à fournir se trouve directement dans la doc API dans la section :
- Model : Invoice
L'api Kiwiz vous retournera le hash du fichier et le hash du block :
{
"file_hash": "PQkd3574xgdSDGdgsf5kihbfiudf5df7gds37SDGsdg",
"block_hash": "PQkd3574xgdSDlufhzuoh448ezr48f57gds37SDGsdg"
}
Le block hash vous servira pour faire vos "get".
B : Récupération des factures :
Vous pouvez récupérer vos factures en interrogeant l'API Kiwiz avec votre "block_hash".
Documentation de l'API : https://api.kiwiz.io/doc#/Factures/invoiceGet
Attention : seule la facture stockée dans Kiwiz est l'original certifié et inaltérable.
Pensez donc à bien intégré les "get" de Kiwiz lors d'évènement comme l'envoi de facture par email, la récupération par le client de la facture dans son compte, le téléchargement en back office etc ...
Nous vous conseillons aussi de stocker une copie de la facture "get" de Kiwiz sur votre système, afin de ne pas faire trop de requête à l'API.
4 - Gestion des avoirs
A : Envoyer les avoirs à l'API
Vous devez envoyer vos factures et données à l'API
Base URL API : https://api.kiwiz.io/
Documentation de l'API https://api.kiwiz.io/doc#/Avoirs/creditmemoSave
- Document : fichier PDF de l'avoir
- Data : données de l'avoir
La liste des données à fournir se trouve directement dans la doc API dans la section :
- Model : Creditmemo
L'api Kiwiz vous retournera le hash du fichier et le hash du block :
{
"file_hash": "PQkd3574xgdSDGdgsf5kihbfiudf5df7gds37SDGsdg",
"block_hash": "PQkd3574xgdSDlufhzuoh448ezr48f57gds37SDGsdg"
}
Le block hash vous servira pour faire vos "get".
B : Récupération des avoirs :
Vous pouvez récupérer vos avoirs en interrogeant l'API Kiwiz avec votre "block_hash".
Documentation de l'API : https://api.kiwiz.io/doc#/Avoirs/creditmemoGet
Attention : seul l'avoir est stockée dans Kiwiz est l'original certifié et inaltérable.
Pensez donc à bien intégré les "get" de Kiwiz lors d'évènement comme l'envoi d'avoir par email, la récupération par le client de l'avoir dans son compte, le téléchargement en back office etc ...
Nous vous conseillons aussi de stocker une copie de l'avoir "get" de Kiwiz sur votre système, afin de ne pas faire trop de requête à l'API.
Related articles