Enquête

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 Verviers Ambitions ?

  • PrestaShop
  • WooCommerce
  • Shopify
  • Magento
  • OpenCart
  • Wordpress
  • PHP générique
  • .NET
  • Autre

API Verviers Ambitions

L'API Verviers Ambitions 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.

URL de base
api.boncado.be

Clé API

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

Clé API
La clé API est renseignée dans les paramètres du compte Verviers Ambitions. Connectez-vous ou demandez au gestionnaire du compte de vous la transmettre.

Erreurs

Verviers Ambitions 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 Verviers Ambitions.

Codes d'erreur
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 Verviers Ambitions est en échec, nous sommes probablement déjà au courant.

ME

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.

ME >> Définition

login string

Adresse email principale et login du compte


emails array

Adresses emails secondaires où recevoir des copies des emails transactionnels Verviers Ambitions


company string

Nom de société


vatnumber string

Numéro de TVA


first_name string

Prénom


last_name string

Nom de famille


street string

Rue


street2 string

Complément d'adresse


house_number string

Numéro de rue


mail_box string

Boite postale


city string

Localité


post_code string

Code postal


country string

Code pays (ISO 3166-1 alpha-2)


phone string

Numéro de téléphone fixe


mobile_phone string

Numéro de GSM


newsletter_flag boolean


language string

Langue de l'utilisateur


plan string

Plan tarifaire actuel


iban string

Numéro de compte IBAN sur lequel Verviers Ambitions reverse l'argent des chèques-cadeaux dépensés dans l'un de vos commerces.


expiration_date date

Date du dernier renouvellement de l'abonnement


Objet
{
   "login": "",
   "emails": ,
   "company": "",
   "vatnumber": "",
   "first_name": "",
   "last_name": "",
   "street": "",
   "street2": "",
   "house_number": "",
   "mail_box": "",
   "city": "",
   "post_code": "",
   "country": "",
   "phone": "",
   "mobile_phone": "",
   "newsletter_flag": false,
   "language": "",
   "plan": "",
   "iban": "",
   "expiration_date": ,
}

ME >> GET

Renvoyer les informations de votre compte.

Endpoint
GET /v1/me
1. curl https://api.boncado.be/v1/me \
2. -u sk_60a2a1ca98ea460a2a1ca98ea4: \
A venir..

ME >> PATCH

Modifier les valeurs éditables de votre compte.

Endpoint
PATCH /v1/me
1. curl https://api.boncado.be/v1/me \
2. -u sk_60a2a1ca98ea460a2a1ca98ea4: \
3. -d street="Rue Nouvelle"
A venir..

BUSINESS

L'objet BUSINESS contient les informations relatives à une activité commerciale enregistrée sur votre compte Verviers Ambitions. 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.

BUSINESS >> Définition

id string

Identifiant numérique de l'établissement commercial.


online boolean

Booléen indiquant si l'enseigne est publiée/active.


name string

Nom de l'établissement commercial.


alias string

Fragment d'url unique assigné à l'établissement commercial.


street string

Rue


street2 string

Complément d'adresse


house_number string

Numéro de rue


post_code string

Code postal


city string

Localité


country string

Code pays (ISO 3166-1 alpha-2)


latitude string

Latitude de la position géographique de l'établissement commercial.


longitude string

Longitude de la position géographique de l'établissement commercial.


email string

Email principal.


email2 string

Email secondaire.


phone string

Numéro de téléphone.


mobile string

Numéro de GSM.


facebook string

URL de la page Facebook.


instagram string

URL de la page Instagram.


linkedin string

URL de la page LinkedIn.


website string

URL du site Internet.


category1 string

Secteur d'activité principal de l'établissement commercial.


category2 string

Secteur d'activité secondaire de l'établissement commercial


nace string

Code NACE principal.


iban string

Numéro de compte IBAN sur lequel Verviers Ambitions 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.


Objet
{
   "id": "2336",
   "online": true,
   "name": "",
   "alias": "5f1c1ce0effc5a",
   "street": "",
   "street2": "",
   "house_number": "",
   "post_code": "",
   "city": "",
   "country": "",
   "latitude": "0.000000",
   "longitude": "0.000000",
   "email": "",
   "email2": "",
   "phone": "",
   "mobile": "",
   "facebook": "",
   "instagram": "",
   "linkedin": "",
   "website": "",
   "category1": "0",
   "category2": "0",
   "nace": "",
   "iban": "",
}

BUSINESS >> LIST

Renvoyer une liste des activités commerciales liées à votre compte Verviers Ambitions.

Endpoint
GET /v1/business
1. curl https://api.boncado.be/v1/business \
2. -u sk_60a2a1ca98ea460a2a1ca98ea4: \
A venir..

BUSINESS >> GET

Renvoyer les informations de votre compte.

Endpoint
GET /v1/business/id
1. curl https://api.boncado.be/v1/business/1234 \
2. -u sk_60a2a1ca98ea460a2a1ca98ea4: \
A venir..

BUSINESS >> PATCH

Modifier les valeurs éditables de votre compte.

Endpoint
PATCH /v1/business/id
1. curl https://api.boncado.be/v1/business/1234 \
2. -u sk_60a2a1ca98ea460a2a1ca98ea4: \
3. -d latitude="53"
A venir..

VOUCHER

L'objet VOUCHER contient les informations relatives à un chèque Verviers Ambitions. 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 Verviers Ambitions, de récupérer les informations relatives à un chèque enregistré et de modifier le statut du chèque.

VOUCHER >> Définition

voucher_value decimal

Valeur faciale du chèque Verviers Ambitions.


voucher_majoration_value string

Part offerte par un ou plusieurs promoteurs.


where_type string

Type de Verviers Ambitions.


city_id string

Numéro d'identifiant de la ville quand il s'agit d'un Verviers Ambitions CITY.


business string

Numéro de l'établissement commercial.


gift_from string

Nom de la personne qui offre imprimé sur le chèque.


gift_to string

Nom du bénficiaire imprimé sur le chèque.


majs array

Liste des majorations appliquées sur le chèque.


delivery string

Méthode de livraison


host string

Hôte sur lequel le chèque a été acheté.


expiration_date string

Date d'expiration


voucher_id string

Chaîne alphanumérique unique identifiant le chèque Verviers Ambitions.


is_recorded boolean

Booléen indiquant si le chèque a été encaissé.


refund_date date

Date à laquelle le bon a été reversé au commerçant.


Objet
{
   "voucher_value": ,
   "voucher_majoration_value": "",
   "where_type": "",
   "city_id": "",
   "business": "",
   "gift_from": "",
   "gift_to": "",
   "majs": ,
   "delivery": "",
   "host": "",
   "expiration_date": "",
   "voucher_id": "",
   "is_recorded": false,
   "refund_date": ,
}

VOUCHER >> LIST

Renvoyer une liste des chèques enregistrés/encaissés depuis votre compte Verviers Ambitions.

Endpoint
GET /v1/vouchers
1. curl https://api.boncado.be/v1/vouchers \
2. -u sk_60a2a1ca98ea460a2a1ca98ea4: \
A venir..

VOUCHER >> GET

Renvoyer les informations relatives à un chèque cadeau. Cette requête API vous permet de vérifier qu'un chèque Verviers Ambitions est valide et peut-être accepté comme mode de paiement.

Endpoint
GET /v1/vouchers/id
1. curl https://api.boncado.be/v1/vouchers/60759eb008f8b \
2. -u sk_60a2a1ca98ea460a2a1ca98ea4: \
A venir..

VOUCHER >> PATCH

Modifier le statut d'un chèque en circulation, à utiliser pour l'acceptation d'un chèque sur un site e-commerce.

Endpoint
PATCH /v1/vouchers/id
1. curl https://api.boncado.be/v1/vouchers/60759eb008f8b \
2. -u sk_60a2a1ca98ea460a2a1ca98ea4: \
3. -d gift_to ="Luc Dupont"
4. -d is_recorded ="1"
A venir..

Le site Internet Verviers Ambitions 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.