Nous sommes désireux de répondre aux besoins les plus sollicités, aussi aimerions-nous en savoir plus sur votre projet. Dans quel environnement comptez-vous utiliser l'API Boncado ?
L'API Boncado est organisée sur base de l'architecture REST. Les requêtes effectuées sur l'URI produisent une réponse dont le corps est formaté en JSON. Les méthodes HTTP disponibles sont GET, POST, PUT, PATCH, DELETE.
Pour utiliser l'API, vous devez fournir votre clé API. Gardez toujours la clé API que nous vous communiquons sur votre dashboard secrète! Cette clé devra être incluse dans chacune des requêtes API
Boncado utilise des codes de réponse HTTP conventionnels pour indiquer le succès ou l'échec d'une requête API. Les codes de la gamme 2xx indiquent le succès. Les codes dans la plage 4xx indiquent une erreur de formulation de la requête. Les codes de la gamme 5xx indiquent une erreur avec les serveurs de Boncado.
| 200 | Tout s'est déroulé comment attendu! |
|---|---|
| 400 | La requête a été rejetée, la raison la plus fréquent est l'oubli d'un paramètre. |
| 401 | La clé d'API est inconnue. |
| 402 | La requête est correcte mais l'API est incapable de renvoyer une réponse. Cela peut survenir par exemple quand les paramètres du compte sont incomplets. |
| 403 | La clé d'API n'octroie pas les permissions nécessaires à la requête. |
| 404 | La ressource n'existe pas. |
| 429 | Trop de requêtes ont été exécutées dans un délai court. |
| 50x | Le serveur Boncado est en échec, nous sommes probablement déjà au courant. |
L'objet ME contient les informations relatives à votre profil client. L'API vous permet de récupérer les informations et de modifier certaines valeurs.
stringAdresse email principale et login du compte
arrayAdresses emails secondaires où recevoir des copies des emails transactionnels Boncado
stringNom de société
stringNuméro de TVA
stringPrénom
stringNom de famille
stringRue
stringComplément d'adresse
stringNuméro de rue
stringBoite postale
stringLocalité
stringCode postal
stringCode pays (ISO 3166-1 alpha-2)
stringNuméro de téléphone fixe
stringNuméro de GSM
booleanstringLangue de l'utilisateur
stringPlan tarifaire actuel
stringNuméro de compte IBAN sur lequel Boncado reverse l'argent des chèques-cadeaux dépensés dans l'un de vos commerces.
dateDate du dernier renouvellement de l'abonnement
Renvoyer les informations de votre compte.
1. curl https://api.boncado.be/v1/me \2. -u sk_60a3a194b2eeb60a3a194b2eeb: \ Modifier les valeurs éditables de votre compte.
1. curl https://api.boncado.be/v1/me \2. -u sk_60a3a194b2eeb60a3a194b2eeb: \3. -d street="Rue Nouvelle" L'objet BUSINESS contient les informations relatives à une activité commerciale enregistrée sur votre compte Boncado. L'API vous permet de lister toutes vos activités, de récupérer les informations relatives à une activité et de modifier les valeurs éditables.
stringIdentifiant numérique de l'établissement commercial.
booleanBooléen indiquant si l'enseigne est publiée/active.
stringNom de l'établissement commercial.
stringFragment d'url unique assigné à l'établissement commercial.
stringRue
stringComplément d'adresse
stringNuméro de rue
stringCode postal
stringLocalité
stringCode pays (ISO 3166-1 alpha-2)
stringLatitude de la position géographique de l'établissement commercial.
stringLongitude de la position géographique de l'établissement commercial.
stringEmail principal.
stringEmail secondaire.
stringNuméro de téléphone.
stringNuméro de GSM.
stringURL de la page Facebook.
stringURL de la page Instagram.
stringURL de la page LinkedIn.
stringURL du site Internet.
stringSecteur d'activité principal de l'établissement commercial.
stringSecteur d'activité secondaire de l'établissement commercial
stringCode NACE principal.
stringNuméro de compte IBAN sur lequel Boncado reverse l'argent des chèques-cadeaux dépensés dans l'établissement commercial. S'il est renseigné au niveau de BUSINESS, il écrase la valeur définie au niveau ME.
Renvoyer une liste des activités commerciales liées à votre compte Boncado.
1. curl https://api.boncado.be/v1/business \2. -u sk_60a3a194b2eeb60a3a194b2eeb: \ Renvoyer les informations de votre compte.
1. curl https://api.boncado.be/v1/business/1234 \2. -u sk_60a3a194b2eeb60a3a194b2eeb: \ Modifier les valeurs éditables de votre compte.
1. curl https://api.boncado.be/v1/business/1234 \2. -u sk_60a3a194b2eeb60a3a194b2eeb: \3. -d latitude="53" L'objet VOUCHER contient les informations relatives à un chèque Boncado. L'API vous permet de lister tous les chèques enregistrés par vos activités commerciales, de vérifier la validité d'un chèque en circulation sur le réseau Boncado, de récupérer les informations relatives à un chèque enregistré et de modifier le statut du chèque.
decimalValeur faciale du chèque Boncado.
stringPart offerte par un ou plusieurs promoteurs.
stringType de Boncado.
stringNuméro d'identifiant de la ville quand il s'agit d'un Boncado CITY.
stringNuméro de l'établissement commercial.
stringNom de la personne qui offre imprimé sur le chèque.
stringNom du bénficiaire imprimé sur le chèque.
arrayListe des majorations appliquées sur le chèque.
stringMéthode de livraison
stringHôte sur lequel le chèque a été acheté.
stringDate d'expiration
stringChaîne alphanumérique unique identifiant le chèque Boncado.
booleanBooléen indiquant si le chèque a été encaissé.
dateDate à laquelle le bon a été reversé au commerçant.
Renvoyer une liste des chèques enregistrés/encaissés depuis votre compte Boncado.
1. curl https://api.boncado.be/v1/vouchers \2. -u sk_60a3a194b2eeb60a3a194b2eeb: \ Renvoyer les informations relatives à un chèque cadeau. Cette requête API vous permet de vérifier qu'un chèque Boncado est valide et peut-être accepté comme mode de paiement.
1. curl https://api.boncado.be/v1/vouchers/60759eb008f8b \2. -u sk_60a3a194b2eeb60a3a194b2eeb: \ Modifier le statut d'un chèque en circulation, à utiliser pour l'acceptation d'un chèque sur un site e-commerce.
1. curl https://api.boncado.be/v1/vouchers/60759eb008f8b \2. -u sk_60a3a194b2eeb60a3a194b2eeb: \3. -d gift_to ="Luc Dupont"4. -d is_recorded ="1" Le site Internet Boncado utilise des cookies. Certains cookies sont nécessaires au bon fonctionnement du site Internet et, s'ils sont désactivés, provoquent une dégradation de l'expérience utilisateur ou désactivent certaines fonctionnalités du site. D'autres cookies sont utilisés à des fins d'analyse ou de marketing.