Aller au contenu
Sections de la documentation

Premiers pas avec la Shipment Management API

La Shipment Management API de Safecube gère les expéditions de votre espace de travail de l'application web Safecube depuis vos propres outils et systèmes. Elle sert à :

  • garder automatiquement les expéditions de votre espace de travail synchronisées avec vos outils internes ;
  • récupérer le lien de partage public d'une expédition, pour partager ou intégrer son suivi sans connexion. Un lien de partage public peut être intégré en iframe.

L'API crée des expéditions de façon asynchrone, supprime des expéditions et recherche les liens publics de plusieurs expéditions à la fois. Son URL de base est https://api.sinay.ai/safecube/api/v1.

Obtenir l'accès

La Shipment Management API est incluse dans tous les plans Safecube : il n'y a aucun accès à demander. L'intégration d'un lien de partage public en iframe est différente : elle fait partie du pack marque blanche et reste sur demande, car Safecube doit autoriser votre domaine. La page Intégrer une expédition dans une iframe détaille cette demande.

Chaque requête est authentifiée par votre clé d'API Safecube dans l'en-tête API_KEY, comme décrit sur la page Authentification.

Créer des expéditions

POST /public/shipments crée une ou plusieurs expéditions dans votre espace de travail, de façon asynchrone.

  • Un e-mail vous est envoyé une fois le processus de création terminé.
  • L'e-mail donne le statut de la création et les éventuelles erreurs.

Supprimer des expéditions

DELETE /public/shipments supprime une ou plusieurs expéditions de votre espace de travail Safecube. Une expédition supprimée n'est plus mise à jour, ne déclenche plus d'alertes et n'est plus facturée.

Rechercher des expéditions et leurs liens publics

POST /public/shipments/search renvoie le détail d'expéditions de votre espace de travail et leurs liens de partage publics.

Le lien public ouvre la page publique de l'expédition, qui ne demande aucune connexion. La page affiche :

  • le numéro de connaissement et le transporteur ;
  • l'origine et la destination, avec la date de départ et l'ETA ;
  • une barre de progression du voyage ;
  • l'ETA, l'ETD, le navire et le nombre de conteneurs ;
  • la chronologie des events — date, description, lieu et navire — avec un bouton pour les afficher sur une carte ;
  • le tableau des conteneurs — numéro de conteneur, dernier event, lieu, dernière date et statut.

Quand l'intégration en iframe est autorisée pour votre domaine, le lien public peut être intégré dans vos propres pages en iframe. La page Intégrer une expédition dans une iframe détaille l'intégration.