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.
string
Adresse email principale et login du compte
array
Adresses emails secondaires où recevoir des copies des emails transactionnels Boncado
string
Nom de société
string
Numéro de TVA
string
Prénom
string
Nom de famille
string
Rue
string
Complément d'adresse
string
Numéro de rue
string
Boite postale
string
Localité
string
Code postal
string
Code pays (ISO 3166-1 alpha-2)
string
Numéro de téléphone fixe
string
Numéro de GSM
boolean
string
Langue de l'utilisateur
string
Plan tarifaire actuel
string
Numéro de compte IBAN sur lequel Boncado reverse l'argent des chèques-cadeaux dépensés dans l'un de vos commerces.
date
Date du dernier renouvellement de l'abonnement
Renvoyer les informations de votre compte.
1. curl https://api.boncado.be/v1/me \2. -u sk_628799e5b9d77628799e5b9d77: \
Modifier les valeurs éditables de votre compte.
1. curl https://api.boncado.be/v1/me \2. -u sk_628799e5b9d77628799e5b9d77: \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.
string
Identifiant numérique de l'établissement commercial.
boolean
Booléen indiquant si l'enseigne est publiée/active.
string
Nom de l'établissement commercial.
string
Fragment d'url unique assigné à l'établissement commercial.
string
Rue
string
Complément d'adresse
string
Numéro de rue
string
Code postal
string
Localité
string
Code pays (ISO 3166-1 alpha-2)
string
Latitude de la position géographique de l'établissement commercial.
string
Longitude de la position géographique de l'établissement commercial.
string
Email principal.
string
Email secondaire.
string
Numéro de téléphone.
string
Numéro de GSM.
string
URL de la page Facebook.
string
URL de la page Instagram.
string
URL de la page LinkedIn.
string
URL du site Internet.
string
Secteur d'activité principal de l'établissement commercial.
string
Secteur d'activité secondaire de l'établissement commercial
string
Code NACE principal.
string
Numé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_628799e5b9d77628799e5b9d77: \
Renvoyer les informations de votre compte.
1. curl https://api.boncado.be/v1/business/1234 \2. -u sk_628799e5b9d77628799e5b9d77: \
Modifier les valeurs éditables de votre compte.
1. curl https://api.boncado.be/v1/business/1234 \2. -u sk_628799e5b9d77628799e5b9d77: \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.
decimal
Valeur faciale du chèque Boncado.
string
Part offerte par un ou plusieurs promoteurs.
string
Type de Boncado.
string
Numéro d'identifiant du promoteur lorsque le chèque est vendu via une ville, une association ou un site délabellisé
string
Numéro de l'établissement commercial.
string
Nom de la personne qui offre imprimé sur le chèque.
string
Nom du bénficiaire imprimé sur le chèque.
array
Liste des majorations appliquées sur le chèque.
string
Méthode de livraison
string
Hôte sur lequel le chèque a été acheté.
string
Date d'expiration
string
Chaîne alphanumérique unique identifiant le chèque Boncado.
boolean
Booléen indiquant si le chèque a été encaissé.
date
Date à 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_628799e5b9d77628799e5b9d77: \
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_628799e5b9d77628799e5b9d77: \
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_628799e5b9d77628799e5b9d77: \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.