API Intégration

Documentation de l'API

L'API du Calculateur de CBM est organisée autour de REST. Notre API accepte les requêtes HTTP POST avec des données JSON dans le corps du message en utilisant l'en-tête de requête Content-Type: application/json, et renvoie des réponses encodées en JSON.
L'API du Calculateur de CBM utilise des codes de réponse HTTP standard.


                            BASE URL


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


                                JSON Input Object

                                
    {
    "length": 45,
    "width" : 55,
    "height" : 65,
    "quantity": 10,
    "weight" : 1,
    "uom" : "cm",
    "wuom" : "kg",
    "apikey" : "put your api key here",
    "token" : ""
    }

Paramètre	Valeurs possibles	Type
longueur	Longueur du carton/colis	Numéro
largeur	Largeur du carton/colis	Numéro
hauteur	Hauteur du carton/colis	Numéro
quantité	Quantité de carton/colis	Numéro
poids	Poids du carton/colis	Numéro
uom	Unité de mesure pour la longueur, la largeur et la hauteur du carton/colis : Valeurs possibles mm cm mètre pouce pied yard	String
wuom	Unité de mesure du poids pour le carton/colis : kg, lb Valeurs possibles kg lb	String
apikey	La clé API sera payante ou gratuite, vous pouvez l'obtenir depuis votre page de Profil.	String
token	Initialement, il s'agira d'une chaîne vide. Vous recevrez un token en réponse de l'API. Une fois que vous avez le token, vous devez le renvoyer dans les appels suivants pour une session unique	String


                                JSON Output Object

                                
    {
        "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	Numéro
cmtotal	Volume des cartons/colis en mètres cubes	Numéro
con20	Nombre approximatif de cartons/colis pouvant remplir un conteneur de 20 pieds	Numéro
con40	Nombre approximatif de cartons/colis pouvant remplir un conteneur de 40 pieds	Numéro
con40hc	Nombre approximatif de cartons/colis pouvant remplir un conteneur High Cube de 40 pieds	Numéro
description	Il aura une valeur sans espaces en cas de statut échec	String
kgweight	Poids en kg de tous les cartons/colis	Numéro
kgweightvolume	Poids volumétrique (mer) en kg pour le nombre total de cartons/colis	Numéro
kgweightvolumeair	Poids volumétrique (air) en kg pour le nombre total de cartons/colis	String
lbweight	Poids en livres (lb) de tous les cartons/colis	Numéro
lbweightvolume	Poids volumétrique (mer) en livres (lb) pour le nombre total de cartons/colis	Numéro
lbweightvolumeair	Poids volumétrique (air) en livres (lb) pour le nombre total de cartons/colis	String
status	Soit success, soit failed. En cas de failed, description contiendra les détails de l'erreur	String
token	Token de session généré par l'API que vous devez envoyer après le premier appel	String