Comment commencer avec l'API de Suivi des Colis

Comment accéder à l’API

Pour commencer, explorons comment accéder à l’API. Les utilisateurs doivent se connecter au portail développeur à l’aide de leur adresse e-mail. Après l’inscription, un développeur reçoit :

  • 100 requêtes de test (une seule fois).
  • Une clé d’accès secrète pour l’API.

Clé d’accès secrète pour l’API

La clé d’accès secrète pour l’API est un identifiant unique pour le développeur qui doit être inclus dans le chemin de la requête API pour l’authentification. Ne partagez pas cette clé avec quiconque. Si quelqu’un obtient votre clé, il pourra utiliser votre solde de requêtes. Vous pouvez trouver cette clé dans votre tableau de bord de compte.

Exemple :

//URL de requête API pour obtenir tous les transporteurs var request_url = "https://developers.chinaparcels.com/api/v1/user/{USER_API_SECRET_ACCESS_KEY}/carriers";

Catégories de l’API REST

Notre API REST est divisée en deux catégories principales :

Colis

  • Identifier les transporteurs en fonction du numéro de suivi d’un colis.
  • Suivre un colis avec détection automatique du transporteur.
  • Suivre un colis avec un transporteur spécifié.

Transporteurs

  • Voir une liste complète des transporteurs pris en charge.
  • Accéder à des informations détaillées sur un transporteur spécifique.