API - Mode revendeur
- Jean-michel Arini (Unlicensed)
- Sophie Rocco
Vous avez un compte Kiwiz pour votre solution de facturation et vous avez la nécessité de gérer des sous comptes pour vos clients ? Le mode revendeur est fait pour vous !
Grâce au mode revendeur, votre compte principal vous permet au travers de notre API de créer et de supprimer des comptes Kiwiz. Lors de la création des sous comptes, vous avez la possibilité de choisir parmi les différents plans revendeurs mis à votre disposition.
Chacun de vos clients doit avoir son propre compte. Si votre client a plusieurs systèmes de caisse, il vous faudra un abonnement par caisse.
Lors de la création de votre compte revendeur vous recevrez vos identifiants API ainsi qu'un subscription ID à ne pas utiliser. En effet il ne faut pas envoyer des factures dans le compte revendeur car elle seront détruites.
Compte principal
Grace aux identifiants login et mot de passe de votre compte principal vous générez un token disposant des droits revendeurs : https://api.kiwiz.io/doc#/Tokens/authLogin
Veillez à utiliser uniquement votre login et votre mot de passe pour générer des tokens disposant des droits "revendeur".
Grace à ce token vous pourrez :
- Gérer vos souscriptions - https://api.kiwiz.io/doc#/Souscriptions
- Récupérer les plans disponibles - https://api.kiwiz.io/doc#/Plans
Il nous arrive parfois, pour des raisons techniques d'invalider des tokens. Dans ce cas, en cas d'appel, l'API Kiwiz vous répondra un code 401 vous demandant de générer un nouveau token
Schéma général
Gestion des sous comptes
Création d'une souscription - https://api.kiwiz.io/doc#/Souscriptions/subscriptionAdd
Pour chaque abonnement client vous devez fournir les informations suivantes :
- pland_id : L'identifiant du plan choisi. Les plans disponible pour votre compte revendeur se récupèrent via l'API : https://api.kiwiz.io/doc#/Plans/planGet
- company_name : Le nom de la société de votre client
- legal_representative_name : Le nom du représentent légal de la société renseignée dans le champs company_name.
closing_fiscal_date : Prochaine date de clôture de l'exercice comptable de la société renseignée dans le champs company_name.
- company_email : Email qui recevra l'attestation de conformité de KIWIZ et les emails de clôture qui seront envoyés tous les jours, tous les mois, tous les ans.
Les autres champs platform et version vous permettent de pousser des infos techniques pour vos besoins personnels.
L'attestation individuelle de conformité sera adressée au nom de la société et de son représentant légal mentionnés dans les champs company_name et legal_representative_name
En retour, l'API vous fournit un ID de souscription qui, associé à votre login et mot de passe revendeur, vous permet de générer un token disposant des droit "client".
Nous vous conseillons de stocker le token ainsi que l'ID de souscription de chacun de vos clients.
Annuler une souscription - https://api.kiwiz.io/doc#/Souscriptions/subscriptionCancel
Vous avez la possibilité, au travers de l'API, d'annuler des souscriptions.
En renseignant le champs cancel_at_end vous avez 2 possibilités :
- cancel_at_end=1 : La souscription est annulée à la fin de sa période de validité.
- cancel_at_end=0 : La souscription est annulée immédiatement.
Il est impossible de réactiver une souscription annulée.
Seule les souscriptions devant être annulées à la fin de leur période de validité peuvent être réactivées : https://api.kiwiz.io/doc#/Souscriptions/subscriptionReactivate