Chargement
Message
Si vous êtes familier avec les API Rest, l’API BCVTC sera un jeu d’enfant pour vous.
Avec l’API BCVTC vous pourrez bénéficier de toutes les fonctionnalités de l’application côté serveur tel que la création des bons de commande, devis et envoyer des demandes de réservations sur votre smartphone.
Vous pouvez également mettre à jour un bon de commande ou un devis et les valider si besoin.
Pour pouvoir utiliser l’API BCVTC vous devez être inscrit en tant qu’utilisateur et valider votre adresse mail car elle vous servira comme identifiant.
https://api.bcvtc.fr/v1
Toutes les requêtes doivent être en POST
Tous les attributs et paramètres sont en Pascal Case
Toutes les réponses sont en JSON.
{
"Status" : "OK",
"Message" : "Message de réponse",
"Data" : {}
}
Attribut | Type | Description |
---|---|---|
Status | (String) | Contient le statut de la requête OK si tout va bien ou ERROR si la requête n’a pas pu être traitée ou un paramètre obligatoire est manquant. |
Message | (String) | Un simple message du serveur concernant la requête |
Data | (Object) | contient les attributs et les données de la réponse |
Vous devez utiliser votre API KEY que vous trouverez directement dans l’application (MENU > Paramètres > Api) à la fin du lien de l’endpoint et envoyer votre email en paramètre
Vous devez également envoyer votre adresse mail en paramètre pour chaque requête
curl https://api.bcvtc.fr/v1/driver/profil/{Votre clé API} \
-d Email=email@bcvtc.fr
Pour récupérer vos informations de base veuillez utiliser l'endpoint suivant :
driver/profil/{Votre clé Api}
Et envoyer votre adresse mail en paramètre
curl https://api.bcvtc.fr/v1/driver/profil/{Votre clé API} \
-d Email=email@bcvtc.fr
Paramètres | Type | Description |
---|---|---|
(String) | L'adresse mail utilisée lors de votre inscription |
{
"Status": "OK",
"Message": "Data OK",
"Data": {
"UserPicture": "https Link",
"UserFirstName": "Ryan",
"UserLastName": "Chappelle",
"UserEmail": true,
"UserPhoneNumber": true,
"UserCompanySiren": "123456789",
"UserCompanyName": "COMPANYBCVTC",
"UserCompanyAddress": "Paris, France",
"UserCompanyStatut": "1",
"UserCompanyVAT": "FR00123456789",
"AppyVAT": false,
"UserLicenseNumber": "EVTC123456789"
}
}
Attribut | Type | Description |
---|---|---|
UserPicture | (String) | Lien https ou http de l'image de profil |
UserFirstName | (String) | Prénom chauffeur |
UserLastName | (String) | Nom chauffeur |
UserCompanySiren | (String) | Numéro de siren de l'entreprise du chauffeur. |
UserCompanyName | (String) | Dénomination sociale. |
UserCompanyAddress | (String) | Siège social de l'entreprise |
UserCompanyVAT | (String) | Numéro de TVA |
AppyVAT | Bool | Renvoie true si la TVA est applicable |
UserLicenseNumber | (String) | Numéro d'EVTC |
Le chauffeur doit créer au moins une classe pour pouvoir ajouter des véhicules.
Si vous souhaitez faire des calculs manuels, vous pouvez demander les informations de chaque classe via l'endpoint suivant :
driver/classes/{Votre clé Api}
Et envoyer votre adresse mail en paramètre
curl https://api.bcvtc.fr/v1/driver/classes/{Votre clé API} \
-d Email=email@bcvtc.fr
Paramètres | Type | Description |
---|---|---|
(String) | L'adresse mail utilisée lors de votre inscription |
{
"Status": "OK",
"Message": "Data OK",
"Data": [
{
"ClassId": "17",
"ClassName": "Berline",
"KmPrice": "1",
"MinutePrice": "0.5",
"BasePrice": "2",
"MiniPrice": "5",
"PaxesVolume": "4"
},
{
"ClassId": "18",
"ClassName": "Van",
"KmPrice": "3",
"MinutePrice": "1",
"BasePrice": "2",
"MiniPrice": "10",
"PaxesVolume": "7"
}
]
}}
L'attribut Data renvoie un tableau qui contient toutes les classes créées par le chauffeur
Attribut | Type | Description |
---|---|---|
ClassId | (String) | L'identifiant unique de la classe |
ClassName | (String) | Le nom de la classe |
KmPrice | (String) | Tarif kilométrique sur un kilomètre en € |
MinutePrice | (String) | Tarif minute en € |
BasePrice | (String) | Le tarif de base en €, (autrement dit Prise en charge) qui sera ajouté automatiquement à chaque formule de calcul. |
MiniPrice | (String) | Le prix minimum en €. |
PaxesVolume | (String) | Nombre de places pour les passagers (Sans le chauffeur). |
Les véhicules sont obligatoirement attachés à au moins une classe
Pour pouvoir créer un bon de commande, vous devez envoyer en paramètre l'id du véhicule souhaité, et pour l'obtenir, vous devez récupérer les informations liées à ce dernier :
driver/cars/{Votre clé Api}
curl https://api.bcvtc.fr/v1/driver/cars/{Votre clé API} \
-d Email=email@bcvtc.fr
Paramètres | Type | Description |
---|---|---|
(String) | L'adresse mail utilisée lors de votre inscription |
{
"Status": "OK",
"Message": "Data OK",
"Data": [
{
"CarId": "8",
"CarPicture": false,
"CarBrand": "Mercedes",
"CarModel": "Viano",
"CarVIN": "DS-854-DF",
"CarCo": "110",
"CarClass": {
"ClassId": "17",
"ClassName": "Berline",
"KmPrice": "1",
"MinutePrice": "0.5",
"BasePrice": "2",
"MiniPrice": "5"
}
},
{
"CarId": "9",
"CarPicture": false,
"CarBrand": "Renault",
"CarModel": "Talisman",
"CarVIN": "DS-000-FG",
"CarCo": "90",
"CarClass": {
"ClassId": "18",
"ClassName": "Van",
"KmPrice": "3",
"MinutePrice": "1",
"BasePrice": "2",
"MiniPrice": "10"
}
},
{
"CarId": "10",
"CarPicture": false,
"CarBrand": "Renault",
"CarModel": "Twingo",
"CarVIN": "SD-000-ZE",
"CarCo": null,
"CarClass": {
"ClassId": "17",
"ClassName": "Berline",
"KmPrice": "1",
"MinutePrice": "0.5",
"BasePrice": "2",
"MiniPrice": "5"
}
},
{
"CarId": "12",
"CarPicture": false,
"CarBrand": "Van",
"CarModel": "Van",
"CarVIN": "Van-Van-Van",
"CarCo": "180",
"CarClass": {
"ClassId": "18",
"ClassName": "Van",
"KmPrice": "3",
"MinutePrice": "1",
"BasePrice": "2",
"MiniPrice": "10"
}
}
]
}
L'attribut Data renvoie un tableau qui contient les véhicules enregistrés par le chauffeur
Attribut | Type | Description |
---|---|---|
CarId | (String) | L'identifiant unique du véhicule |
CarPicture | (String) ou (Bool) | Lien https/http du véhicule, renvoie false si introuvable |
CarBrand | (String) | La marque du véhicule |
CarModel | (String) | Le modèle du véhicule |
CarVIN | (String) | Numéro d'immatriculation. |
CarCo | (String) | Emissions de CO2 g/1 km. |
CarClass | (Object) | Regardez la section #Classes |
Pour pouvoir créer des demandes de réservation, des bons ou devis avec forfait, vous devez envoyer l'id du forfait (ClassesFlatId) en paramètre
Pour avoir une liste de tous les forfaits créés par le chauffeur, vous devez appeler cet endpoint :
driver/flats/{Votre clé Api}
curl https://api.bcvtc.fr/v1/driver/flats/{Votre clé API} \
-d Email=email@bcvtc.fr
Paramètres | Type | Description |
---|---|---|
(String) | L'adresse mail utilisée lors de votre inscription |
{
"Status": "OK",
"Message": "Data OK",
"Data": [
{
"FlatPriceName": "Paris - CDG",
"FlatPriceId": "3",
"Prices": [
{
"ClassesFlatId": "1",
"ClassName": "Berline",
"PaxesVolume": "4",
"ClassFlatPrice": 120
},
{
"ClassesFlatId": "2",
"ClassName": "Van",
"PaxesVolume": "7",
"ClassFlatPrice": 150
}
]
},
{
"FlatPriceName": "Paris Orly",
"FlatPriceId": "4",
"Prices": [
{
"ClassesFlatId": "3",
"ClassName": "Berline",
"PaxesVolume": "4",
"ClassFlatPrice": 100
},
{
"ClassesFlatId": "4",
"ClassName": "Van",
"PaxesVolume": "7",
"ClassFlatPrice": 90
}
]
},
{
"FlatPriceName": "Paris DisneyLand",
"FlatPriceId": "5",
"Prices": [
{
"ClassesFlatId": "5",
"ClassName": "Berline",
"PaxesVolume": "4",
"ClassFlatPrice": 160
},
{
"ClassesFlatId": "6",
"ClassName": "Van",
"PaxesVolume": "7",
"ClassFlatPrice": 140
}
]
}
]
}
L'attribut Data renvoie un tableau qui contient tous les forfaits créés par le chauffeur
Attribut | Type | Description |
---|---|---|
FlatPriceName | (String) | Le nom du forfait |
FlatPriceId | (String) | L'id du forfait |
Prices | (Object) | Contient le forfait de chaque classe |
Attribut | Type | Description |
---|---|---|
ClassesFlatId | (String) | L'id du forfait pour attacher aux classes |
ClassName | (String) | Le nom de la classe |
PaxesVolume | (String) | Le nombre de places possibles (sans le chauffeur) |
ClassFlatPrice | (String) | Tarif en € |
Si vous souhaitez attribuer un bon, devis ou demande de réservation à l'un de vos chauffeurs, il suffit d'indiquer sont id en paramètre lors de la création du bon
Pour récupérer la liste de tous les chauffeurs :
driver/drivers/{Votre clé Api}
curl https://api.bcvtc.fr/v1/driver/drivers/{Votre clé API} \
-d Email=email@bcvtc.fr
Paramètres | Type | Description |
---|---|---|
(String) | L'adresse mail utilisée lors de votre inscription |
{
"Status": "OK",
"Message": "Data OK",
"Data": [
{
"DriverId": "7",
"DriverFirstName": "Daniel",
"DriverLastName": "Lafarg",
"DriverPicture": "Lien https"
},
{
"DriverId": "9",
"DriverFirstName": "Ahmed",
"DriverLastName": "LAGGOUN",
"DriverPicture": "Lien https"
},
{
"DriverId": "6",
"DriverFirstName": "Natasha",
"DriverLastName": "Ossman",
"DriverPicture": "Lien https"
},
{
"DriverId": "8",
"DriverFirstName": "David",
"DriverLastName": "Palmer",
"DriverPicture": "Lien https"
}
]
}
Attribut | Type | Description |
---|---|---|
DriverId | (String) | L'id unique du chauffeur |
DriverFirstName | (String) | Prénom du chauffeur |
DriverLastName | (String) | Nom du chauffeur |
DriverPicture | (String) | Lien de photo du profil |
Vous pouvez créer un bon de commande avec les informations d'un client déjà enregistré
D'abord il va falloir récupérer l'id du client :
driver/clients/{Votre clé Api}
curl https://api.bcvtc.fr/v1/driver/clients/{Votre clé API} \
-d Email=email@bcvtc.fr
Paramètres | Type | Description |
---|---|---|
(String) | L'adresse mail utilisée lors de votre inscription |
{
"Status": "OK",
"Message": "Data OK",
"Data": [
{
"ClientId": "7",
"ClientCiv": "Ste",
"ClientFirstName": "Inc",
"ClientLastName": "Apple",
"Initials": "IA"
},
{
"ClientId": "11",
"ClientCiv": "Mr",
"ClientFirstName": "John",
"ClientLastName": "Lebeau",
"Initials": "JL"
},
{
"ClientId": "8",
"ClientCiv": "Ste",
"ClientFirstName": "Inc",
"ClientLastName": "Microsoft",
"Initials": "IM"
},
{
"ClientId": "9",
"ClientCiv": "Mr",
"ClientFirstName": "Mick",
"ClientLastName": "Novic",
"Initials": "MN"
},
{
"ClientId": "10",
"ClientCiv": "Mme",
"ClientFirstName": "Alison",
"ClientLastName": "Taylor",
"Initials": "AT"
}
]
}
L'attribut Data renvoie un tableau qui contient tous les forfaits créés par le chauffeur
Attribut | Type | Description |
---|---|---|
ClientId | (String) | L'id unique du client |
ClientCiv | (String) | Civilité, Mr, Mme ou Ste pour société |
ClientFirstName | (String) | Prénom |
ClientLastName | (String) | Nom de famille |
Initials | (String) | Initiales |
Vous pouvez faire une estimation de prix pour un déplacement ou une mise à disposition
Pour récupérer la liste de tous les chauffeurs :
driver/fare/{Votre clé Api}
curl https://api.bcvtc.fr/v1/driver/fare/{Votre clé API} \
-d Email=email@bcvtc.fr
-d PickUp=13 rue Jean Beausire, 75004 Paris
-d DropOff=63 Avenue Jean Jaurès, 93000 Bobigny
-d TripType=1.1
-d Hours=4
-d Kms=50
Paramètres | Type | Description |
---|---|---|
(String) | L'adresse mail utilisée lors de votre inscription |
{
"Status": "OK",
"Message": "Itinéraire trouvé",
"Data": {
"Prices": [
{
"ClassId": "17",
"ClassName": "Berline",
"DistancePrice": 17.655,
"TimePrice": 16.441666666666666,
"Price": 36,
"TTCPrice": 36,
"PaxesVolume": "4",
"HTPrice": 32.73
},
{
"ClassId": "18",
"ClassName": "Van",
"DistancePrice": 52.965,
"TimePrice": 32.88333333333333,
"Price": 88,
"TTCPrice": 88,
"PaxesVolume": "7",
"HTPrice": 80
}
],
"PaxesVolume": "7",
"IsRounded": true,
"DurationText": "33 minutes",
"DurationValue": 1973,
"DistanceText": "17,7 km",
"DistanceValue": 17655,
"PickUpAddress": "13 rue Jean Beausire, 75004 Paris",
"DropOffAddress": "63 Avenue Jean Jaurès, 93000 Bobigny",
"ApplyVAT": false,
"Mad": false,
"MadTitle": "Déplacement",
"MadHours": 0,
"MadKm": 0
}
}
Attribut | Type | Description |
---|---|---|
IsRounded | (Bool) | true si le tarif (Price) a été arrondi à l'entier le plus proche |
DurationText | (String) | Le temps nécessaire pour faire ce trajet |
DurationValue | (Float) | Le temps nécessaire en secondes pour faire ce trajet |
DistanceText | (String) | La distance entre les deux adresses en Km |
DistanceValue | (Float) | La distance entre les deux adresses en mètre |
PickUpAddress | (String) | Adresse de prise en charge |
DropOffAddress | (String) | Adresse d'arrivée |
ApplyVAT | (Bool) | true si la TVA est applicable |
Mad | (Bool) | true si la course est une mise à disposition |
MadTitle | (String) | Type de course "Déplacement" ou "Mise à disposition" |
MadHours | (Float) | Le nombre d'heures supplémentaires pour la mise à disposition |
MadKm | (Float) | Le nombre de KM supplémentaires pour la mise à disposition |
L'attribut Prices contient tous les tarifs de toutes les classes disponibles sur le compte du chauffeur
Attribut | Type | Description |
---|---|---|
ClassId | (String) | L'id unique de la classe |
ClassName | (String) | Le nom de la classe |
DistancePrice | (Float) | Le tarif pour la distance uniquement |
TimePrice | (Float) | Le tarif pour le temps parcouru uniquement |
Price | (Float) | Tarif total brut en additionnant le tarif de base ou de prise en charge |
TTCPrice | (Float) | Tarif total TTC net |
HTPrice | (Float) | Tarif hors taxes net |
PaxesVolume | (String) | Nombre de places disponibles |
Nos templates MyBCVTC utilisent cet endpoint pour récupérer les informations nécessaires :
driver/mybcvtc/{Votre clé Api}
Et envoyer votre adresse mail en paramètre
curl https://api.bcvtc.fr/v1/driver/mybcvtc/{Votre clé API} \
-d Email=email@bcvtc.fr
Paramètres | Type | Description |
---|---|---|
(String) | L'adresse mail utilisée lors de votre inscription |
{
"Status": "OK",
"Message": "Data OK",
"Data": {
"Company": {
"UserPicture": "https Link",
"UserFirstName": "Ryan",
"UserLastName": "Chappelle",
"UserEmail": true,
"UserPhoneNumber": true,
"UserCompanySiren": "123456789",
"UserCompanyName": "COMPANYBCVTC",
"UserCompanyAddress": "Paris, France",
"UserCompanyStatut": "1",
"UserCompanyVAT": "FR00123456789",
"AppyVAT": false,
"UserLicenseNumber": "EVTC123456789"
},
"Flates": [
{
"FlatPriceName": "Paris - CDG",
"FlatPriceId": "3",
"Prices": [
{
"ClassesFlatId": "1",
"ClassName": "Berline",
"PaxesVolume": "4",
"ClassFlatPrice": 120
},
{
"ClassesFlatId": "2",
"ClassName": "Van",
"PaxesVolume": "7",
"ClassFlatPrice": 150
}
]
},
{
"FlatPriceName": "Paris Orly",
"FlatPriceId": "4",
"Prices": [
{
"ClassesFlatId": "3",
"ClassName": "Berline",
"PaxesVolume": "4",
"ClassFlatPrice": 100
},
{
"ClassesFlatId": "4",
"ClassName": "Van",
"PaxesVolume": "7",
"ClassFlatPrice": 90
}
]
},
{
"FlatPriceName": "Paris DisneyLand",
"FlatPriceId": "5",
"Prices": [
{
"ClassesFlatId": "5",
"ClassName": "Berline",
"PaxesVolume": "4",
"ClassFlatPrice": 160
},
{
"ClassesFlatId": "6",
"ClassName": "Van",
"PaxesVolume": "7",
"ClassFlatPrice": 140
}
]
}
]
}
}
L'attribut Data contient deux Objets, Company et Flates
Company contient les informations de base du chauffeur et les forfaits disponibles, référez-vous à #Profil et #Forfaits
Pour récupérer les informations d'un bon, devis, réservation ou facture, vous devez appeler cet endpoint
curl https://api.bcvtc.fr/v1/ticket/get/{Id du ticket}/{Votre clé API} \
-d Email=email@bcvtc.fr
Paramètres | Type | Description |
---|---|---|
(String) | Votre adresse mail utilisée lors de votre inscription |
Notez bien que vous devez envoyer l'id du ticket dans lien directement, comme la clé de votre api et ça sera le cas pour tous les appels qui concernent les tickets de manière générale
Voici un exemple de réponse
{
"Status": "OK",
"Message": "Data OK",
"Data": {
"TicketId": "fc71b20ee9f9",
"RequestDate": {
"FullDate": "28/02/2018 16:20",
"Date": "28/Feb/2018",
"Time": "16:20"
},
"Client": {
"ClientId": "7",
"ClientCiv": "Ste",
"ClientLastName": "APPLE",
"ClientFirstName": "Inc",
"ClientEmail": "",
"ClientPhone": "0606060606",
"ClientHomeAddress": "60 Rue de Rivoli, Paris, France",
"ClientWorkAddress": "30 Boulevard de Vaugirard, Paris, France"
},
"Driver": {
"DriverId": "6",
"DriverFirstName": "Natasha",
"DriverLastName": "OSSMAN",
"DriverEmail": "mail@bcvtc.fr",
"DriverPhone": "0606060606",
"DriverPicture": "Lien http"
},
"Car": {
"CarId": "8",
"CarClass": "Berline",
"CarClassId": "17",
"CarPicture": false,
"CarBrand": "MERCEDES",
"CarModel": "Viano",
"CarVIN": "DS-854-DF"
},
"Paxes": "6",
"isFlat": false,
"Trip": {
"PickUpAddress": "60 Rue de Rivoli, Paris, France",
"DropOffAddress": "30 Boulevard de Vaugirard, Paris, France",
"TripType": {
"Value": 10,
"Name": "Déplacement",
"Input": "1.1"
},
"TripCo": "0",
"Price": {
"TTC": "25.00",
"HT": "22.73",
"VAT": "2.27",
"IsPayed": true,
"ApplyVAT": false
},
"AddedHours": null,
"AddedKms": null
},
"PickupDate": {
"FullTime": "31/12/2017 16:25",
"Date": "31/Dec/2017",
"Time": "16:25"
},
"PayMethode": {
"Value": "tr",
"Name": "Virement"
},
"Status": {
"Value": 1,
"Name": "Bon de commande",
"IsPayed": true,
"StatusDate": false
},
"TripComment": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque sodales erat odio, id placerat risus semper ut."
}
}
La réponse Json est très claire, tous les objets on déjà été détaillés
Tous les tickets ont un certain nombre d'options ou commandes possibles, tout dépend du statut du ticket
Pour avoir une liste des commandes possibles pour un certain ticket, appelez cet endpoint
curl https://api.bcvtc.fr/v1/ticket/options/{Id du ticket}/{Votre clé API} \
-d Email=email@bcvtc.fr
Paramètres | Type | Description |
---|---|---|
(String) | L'adresse mail utilisée lors de votre inscription |
Voici un exemple de réponse
{
"Status": "OK",
"Message": "Data OK",
"Data": {
"Id": "fc71b20ee9f9",
"Options": [
{
"Name": "Course effectuée",
"Action": 2
},
{
"Name": "Partager",
"Action": 51
},
{
"Name": "Envoyer au client par mail",
"Action": 5
},
{
"Name": "Envoyer au chauffeur",
"Action": 6
},
{
"Name": "Modifier",
"Action": 1
},
{
"Name": "Supprimer",
"Action": 0
}
]
}
}
Attribut | Type | Description |
---|---|---|
Id | (String) | L'id unique du ticket |
Options | (Object) | Contient toutes les options possibles sur ce ticket |
Attribut | Type | Description |
---|---|---|
Name | (String) | Le nom de l'option |
Action | (Int) | Le code de la commande ou l'option à envoyer (regardez le chapitre suivant) |
pour exécuter une commande sur un ticket, vous allez devoir envoyer le numéro de la commande dans le lien de l'endpoint, comme ceci : d
curl https://api.bcvtc.fr/v1/ticket/exec/{Id du ticket}/{Numéro de la commande}/{Votre clé API} \
-d Email=email@bcvtc.fr
Paramètres | Type | Description |
---|---|---|
(String) | L'adresse mail utilisée lors de votre inscription |
Voici un exemple de réponse en envoyant le paramètre numéro 2
{
"Status": "OK",
"Message": "Course marquée comme effectuée, vous pouvez maintenant envoyer la facture à votre client, mais vous devez d'abord la marquer comme payée",
"Data": true
}
Vous pouvez créer une demande de réservation, bon de commande ou devis via l'api :
Pour cela, certains paramètres doivent être envoyés via cet endpoint
curl https://api.bcvtc.fr/v1/ticket/create/{Votre clé API} \
Si vous souhaitez créer un ticket avec les informations que vous avez déjà enregistré sur l'application, le nombre de paramètres à envoyer sera considérablement moins important d'une création avec des informations instantanée
Cependant certains paramètres sont obligatoires et d'autres non, mais tout dépend de ce que vous souhaitez faire
Exemple, si vous souhaitez créer un bon de commande pour un client que vous avez déjà enregistré avec un forfait, vous devez envoyer les paramètres suivants
curl https://api.bcvtc.fr/v1/ticket/create/{Votre clé API} \
-d Email=email@bcvtc.fr
-d TicketType=1
-d ClientId=10
-d PickUpDate=25/02/2018 07:42
-d CarId=8
-d DriverId=6
-d FlatId=5
-d PaymentMethod=tr
-d Pax=1
-d Comment=J'ai besoin d'un parapluie
-d SendRecapToClient=1
Paramètres | Type | Description |
---|---|---|
(String) | (Obligatoire) L'adresse mail utilisée lors de votre inscription | |
TicketType | (String) | (Obligatoire) 1 pour bon de commande, 2 pour devis, 3 pour demande de réservation |
ClientId | (String) | (Facultatif) L'id du client déjà enregistré (Pour récupérer les ids de vos clients, regardez la section #Clients) |
PickUpDate | (String) | (Obligatoire) La date de prise en charge en format dd/mm/yyyy hh:ii, d'autres formats ne seront pas acceptés |
CarId | (String) | (Obligatoire) L'id du véhicule déjà enregistré (Pour récupérer les ids de vos véhicules, regardez la section #Véhicules) |
DriverId | (String) | (Obligatoire) L'id du chauffeur, si vous êtes le chauffeur, envoyez 0, sinon il faut indiquer l'id du l'un de vos chauffeurs déjà enregistré (Pour récupérer les ids de vos chauffeurs, regardez la section #Chauffeurs) |
FlatId | (String) | (Facultatif) Si la course est un forfait de déplacement, il suffit d'envoyer l'id du forfait en question, regardez la section #Forfaits) |
PaymentMethod | (String) | (Obligatoire) Le type de paiement à titre indicatif choisi par le client, es pour espèces, cb pour carte bancaire, tr pour virement et au pour autre |
Pax | (String) | (Obligatoire) Le nombre de voyageurs, entre 1 et 9 |
Comment | (String) | (Facultatif) Commentaire qui sera affiché sur le bon de commande, devis facture etc... |
SendRecapToClient | (Anything) | N'importe quelle valeur, si SendRecapToClient est envoyé en paramètre, un récapitulatif est envoyé au client |
Voici un exemple de réponse en envoyant le paramètre numéro 2
{
"Status": "OK",
"Message": "Course marquée comme effectuée, vous pouvez maintenant envoyer la facture à votre client, mais vous devez d'abord la marquer comme payée",
"Data": true
}
Si par exemple le client n'est pas enregistré, veuillez retirer le paramètre ClientId et ajouter les paramètres suivants
-d ClientCiv=Mr
-d ClientFirstName=Ahmed
-d ClientLastName=Laggoun
-d ClientEmail=Ahmedlaggoun@bcvtc.fr
-d ClientPhone=0601020304
-d AddToMyClients=1
Paramètres | Type | Description |
---|---|---|
ClientCiv | (String) | (Obligatoire) Mr, Mme ou Ste (Pour société) |
ClientFirstName | (String) | (facultatif) Prénom du client |
ClientLastName | (String) | (Obligatoire) Nom de famille |
ClientEmail | (String) | (facultatif) Adresse mail client (très recommandé) |
ClientPhone | (String) | (facultatif) Numéro de téléphone client |
AddToMyClients | (String) | (facultatif) Envoyez ce paramètre si vous souhaitez que le client soit ajouté à votre répertoire clients |
Si la destination n'est pas un forfait, veuillez retirer le paramètre FlatId et ajouter les paramètres suivants
-d ClientCiv=Mr
-d ClientFirstName=Ahmed
-d ClientLastName=Laggoun
-d ClientEmail=Ahmedlaggoun@bcvtc.fr
-d ClientPhone=0601020304
-d AddToMyClients=1
Paramètres | Type | Description |
---|---|---|
PickUpAddress | (String) | (Obligatoire) L'adresse de départ |
DropOffAddress | (String) | (Obligatoire) L'adresse d'arrivée |
MadHours | (Float) | (Facultatif) nombre d'heures de mise à disposition |
MadKMS | (Float) | (Facultatif) nombre de kms de mise à disposition |
PriceTTC | (Float) | (Obligatoire) Tarif plein de la course |
PriceHT | (Float) | (Facultatif) L'application calculera automatiquement la TVA si vous êtes éligible |
Voici un exemple de réponse
{
"Status": "OK",
"Message": "Votre bon de commande a bien été créé",
"Data": {
"TicketId": "170f057ac2b4"
}
}