PoteLBanm

API PoteLBanm

Pour les boutiques en ligne et les transporteurs qui confient leurs livraisons a PoteLBanm depuis leur propre systeme.

Documentation de referenceDemander une cle

Cle API

Une cle de test pour construire l'integration, puis une cle de production. Elle se passe dans l'en-tete X-API-Key.

Envois et etiquettes

Chiffrer un trajet, creer un envoi, recuperer son etiquette PDF et sa preuve de livraison.

Webhooks

Un appel HTTPS signe vers votre serveur a chaque changement de statut.

Limites

Un nombre de requetes par minute propre a chaque cle, annonce dans les en-tetes de reponse.

Routes

POST/v1/public/quotesChiffrer un trajet
POST/v1/public/packagesCreer un envoi
GET/v1/public/packagesLister vos envois
GET/v1/public/packages/:trackingNumberStatut et historique d'un envoi
GET/v1/public/packages/:trackingNumber/labelEtiquette PDF
GET/v1/public/packages/:trackingNumber/proofPreuve de livraison
POST/v1/public/expressCommander une course express
GET/v1/public/zonesZones desservies
GET/v1/public/productsProduits a tarif fixe
GET/v1/public/creditCredit disponible et encours
GET/v1/public/statsVolumes et performance

Creer un envoi

curl -X POST https://api.potelbanm.com/v1/public/packages \
  -H "X-API-Key: $POTELBANM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "CMD-1042",
    "weight": 2.5,
    "deliverySpeed": "STANDARD",
    "originZoneCode": "HT-PAP",
    "destinationZoneCode": "HT-CAP",
    "receiverName": "Marie Joseph",
    "receiverPhone": "+50937000000",
    "senderAddress": {
      "street": "Rue Capois", "city": "Port-au-Prince",
      "latitude": 18.54, "longitude": -72.34,
      "instructions": "A cote de la pharmacie"
    },
    "receiverAddress": {
      "street": "Rue 15", "city": "Cap-Haitien",
      "latitude": 19.76, "longitude": -72.2,
      "instructions": "Portail vert"
    }
  }'

La reponse contient le numero de suivi, le statut et le prix. Renvoyer la meme reference rend l'envoi deja cree au lieu d'en creer un second.