Documentation de l’API du Calculateur CBM

L’API du Calculateur CBM est organisée autour du protocole REST. Notre API accepte des requêtes HTTP POST contenant des données JSON dans le corps du message, avec l’en-tête Content-Type: application/json, et renvoie des réponses encodées au format JSON.

L’API du Calculateur CBM utilise les codes de réponse HTTP standards.


                        URL DE BASE


                        https://www.cbmcalculator.com/api/CBMCalculator.svc/calculate


                            Objet JSON d’Entrée

                            
{
"length": 45,
"width" : 55,
"height" : 65,
"quantity": 10,
"weight" : 1,
"uom" : "cm",
"wuom" : "kg",
"apikey" : "mettez votre clé API ici",
"token" : ""
}

Paramètre	Valeurs possibles	Type
length	Longueur du carton/colis	Nombre
width	Largeur du carton/colis	Nombre
height	Hauteur du carton/colis	Nombre
quantity	Quantité de cartons/colis	Nombre
weight	Poids du carton/colis	Nombre
uom	Unité de mesure des dimensions du carton/colis valeurs possibles : mm cm meter inch feet yard	Chaîne
wuom	Unité de mesure pour le poids valeurs possibles : kg lb	Chaîne
apikey	La clé API peut être gratuite ou payante. Vous pouvez l’obtenir depuis votre page Profil	Chaîne
token	Initialement une chaîne vide. Vous recevrez un token dans la réponse de l’API. Une fois reçu, vous devez le renvoyer dans les appels suivants pour une session unique.	Chaîne


                            Objet JSON de Sortie

                            
{
    "cftotal": 56.813,
    "cmtotal": 1.609,
    "con20": "180",
    "con40": "360",
    "con40hc": "436",
    "description": null,
    "kgweight": 10,
    "kgweightvolume": 321.75,
    "kgweightvolumeair": 268.125,
    "lbweight": 22.046,
    "lbweightvolume": 709.336,
    "lbweightvolumeair": 591.114,
    "status": "success",
    "token": "712113"
}

Paramètre	Résultat possible	Type
cftotal	Volume des cartons/colis en pieds cubes	Nombre
cmtotal	Volume des cartons/colis en mètres cubes	Nombre
con20	Nombre approximatif de cartons/colis pouvant remplir un conteneur 20 pieds	Nombre
con40	Nombre approximatif de cartons/colis pouvant remplir un conteneur 40 pieds	Nombre
con40hc	Nombre approximatif de cartons/colis pouvant remplir un conteneur 40 pieds High Cube	Nombre
description	Contiendra un message en cas d’erreur lorsque le statut est “failed”	Chaîne
kgweight	Poids total en kilogrammes	Nombre
kgweightvolume	Poids volumétrique (mer) en kg	Nombre
kgweightvolumeair	Poids volumétrique (air) en kg	Chaîne
lbweight	Poids total en livres (lb)	Nombre
lbweightvolume	Poids volumétrique (mer) en livres (lb)	Nombre
lbweightvolumeair	Poids volumétrique (air) en livres (lb)	Chaîne
status	Soit success, soit failed. En cas d’erreur, “description” contiendra les détails.	Chaîne
token	Token de session généré par l’API. Vous devez le renvoyer après le premier appel.	Chaîne

Intégrations API

Documentation de l’API du Calculateur CBM