API des Transporteurs pour les Développeurs

1. Liste Complète des Transporteurs

Une requête GET peut récupérer une liste complète de tous les transporteurs pris en charge par l'API de suivi de Colis de Chine.

Exemple de Requête

curl -X GET "https://developers.chinaparcels.com/api/v1/user/{USER_API_SECRET_ACCESS_KEY}/carriers"

Remarque : Remplacez {USER_API_SECRET_ACCESS_KEY} par votre clé API unique obtenue depuis votre tableau de bord.

Description des Paramètres de Réponse

Voici une explication détaillée des paramètres de réponse :

• error : Code d'erreur indiquant le résultat de la requête (voir la liste des codes d'erreur).
• result : Un tableau d'objets contenant des informations sur les transporteurs.
  • carrier_id : Identifiant unique du transporteur.
  • carrier_name : Nom du transporteur (par exemple, "La Poste Chinoise", "USPS").
  • carrier_type : Type de transporteur (par exemple, "postal", "courrier").
  • carrier_support : Indique si le suivi est pris en charge :
    • 1 : Pris en charge.
    • 0 : Non pris en charge.
  • carrier_country_code : Code pays du transporteur au format ISO 3166-1 alpha-2 (par exemple, "cn" pour la Chine, "us" pour les États-Unis).

Exemple de Réponse (Partielle)

{
  "error": -1,
  "result": [
    {
      "carrier_id": "1",
      "carrier_name": "La Poste Chinoise",
      "carrier_type": "postal",
      "carrier_support": "1",
      "carrier_country_code": "cn"
    },
    {
      "carrier_id": "2",
      "carrier_name": "USPS",
      "carrier_type": "postal",
      "carrier_support": "1",
      "carrier_country_code": "us"
    },
    {
      "carrier_id": "3",
      "carrier_name": "Canada Post",
      "carrier_type": "postal",
      "carrier_support": "1",
      "carrier_country_code": "ca"
    },
    {
      "carrier_id": "4",
      "carrier_name": "Royal Mail",
      "carrier_type": "postal",
      "carrier_support": "1",
      "carrier_country_code": "gb"
    }
  ]
}

Codes d'Erreur

• -1 - Requête réussie ;
• 0 - Utilisateur introuvable ;
• 1 - Solde insuffisant ;

2. Informations Détaillées sur un Transporteur

Une requête GET peut être envoyée pour récupérer des informations détaillées sur un transporteur à l'aide de l'API de suivi de China Parcels.

Exemple de Requête

curl -X GET "https://developers.chinaparcels.com/api/v1/user/{USER_API_SECRET_ACCESS_KEY}/carriers/{CARRIER_ID}"

Remarque :

• Remplacez {USER_API_SECRET_ACCESS_KEY} par votre clé API unique obtenue depuis votre tableau de bord.
• Remplacez {CARRIER_ID} par l'identifiant unique du transporteur obtenu précédemment.

Description des Paramètres de Réponse

• error : Code d'erreur indiquant le résultat de la requête (voir la liste des codes d'erreur).
• result : Un objet contenant des informations détaillées sur le transporteur :
  • carrier_id : Identifiant unique du transporteur.
  • carrier_name : Nom du transporteur (par exemple, "USPS").
  • carrier_type : Type de transporteur (par exemple, "postal", "courrier").
  • carrier_support : Indique si le suivi est pris en charge :
    • 1 : Pris en charge.
    • 0 : Non pris en charge.
  • carrier_website : Site web officiel du transporteur.
  • carrier_email : Adresse e-mail de contact du transporteur (si disponible).
  • carrier_phone : Numéro de téléphone de contact du transporteur (si disponible).
  • carrier_country_code : Code pays du transporteur au format ISO 3166-1 alpha-2.
  • carrier_country_name : Nom complet du pays du transporteur.
  • carrier_icon_background_hex : Couleur de fond de l'icône du transporteur (format HEX).
  • carrier_language_code : Code langue utilisé par le transporteur dans les données de suivi (par exemple, "en" pour anglais).
  • carrier_icon : URL de l'icône du transporteur.
  • carrier_icon_width : Largeur de l'icône du transporteur (en pixels).
  • carrier_icon_height : Hauteur de l'icône du transporteur (en pixels).
  • carrier_thumbnail : URL de la miniature du transporteur.
  • carrier_thumbnail_width : Largeur de la miniature (en pixels).
  • carrier_thumbnail_height : Hauteur de la miniature (en pixels).

Exemple de Réponse

{
  "error": -1,
  "result": {
    "carrier_id": "2",
    "carrier_name": "USPS",
    "carrier_type": "postal",
    "carrier_support": "1",
    "carrier_website": "https://www.usps.com",
    "carrier_email": "support@usps.com",
    "carrier_phone": "1-800-222-1811",
    "carrier_country_code": "us",
    "carrier_country_name": "United States of America",
    "carrier_icon_background_hex": "#333366",
    "carrier_language_code": "en",
    "carrier_icon": "https://developers.chinaparcels.com/cdn/images/carriers/icons/0002-usps.png",
    "carrier_icon_width": 256,
    "carrier_icon_height": 256,
    "carrier_thumbnail": "http://developers.chinaparcels.com/cdn/images/carriers/thumbnails/0002-usps.png",
    "carrier_thumbnail_width": 640,
    "carrier_thumbnail_height": 256
  }
}

Codes d'Erreur

• -1 - Requête réussie ;
• 0 - Utilisateur introuvable ;
• 1 - Solde insuffisant ;
• 2 - Transporteur introuvable ;