API et intégration
Où trouver ma clé d'API ?
Dans l'application web Safecube, ouvrez Developers dans la barre latérale, puis l'onglet API Credentials, ouvert aux Admins et aux Owners sur tous les plans. Copy key copie la clé, même masquée. Un espace de travail a une seule clé : Rotate API key la remplace, et l'ancienne clé cesse de fonctionner aussitôt.
L'onglet est décrit dans Identifiants d'API.
Quelle est la limite de requêtes de l'API ?
La limite actuelle est de 10 requêtes par tranche de 10 secondes par clé d'API, tous endpoints confondus, et elle peut évoluer. Une requête au-delà reçoit 429 Too Many Requests et peut être relancée une fois la fenêtre de 10 secondes passée. Pour suivre beaucoup de conteneurs, les webhooks évitent d'interroger l'API pour chacun.
La limite est décrite dans Limites de requêtes.
Dois-je interroger l'API ou utiliser les webhooks ?
La Container Tracking API, que votre application appelle à la demande, convient aux faibles volumes et aux requêtes ponctuelles. La Webhooks API convient aux gros volumes : vous ajoutez vos expéditions une fois à une liste de suivi, et Safecube envoie un événement à votre endpoint quand de nouvelles données de suivi sont disponibles. Pour les applications plus importantes, Safecube recommande les webhooks.
Les deux approches sont comparées dans Suivi synchrone et asynchrone.
Les expéditions créées par l'API apparaissent-elles dans l'application ?
Celles créées avec la Shipment Management API, oui : POST /public/shipments les crée dans votre espace de travail Safecube, de façon asynchrone, et un email donne le statut de la création et les éventuelles erreurs une fois le traitement terminé. La même API supprime des expéditions et renvoie leurs liens de partage publics.
L'API est décrite dans Premiers pas avec la Shipment Management API.
La Shipment Management API est-elle incluse dans mon plan ?
Oui. La Shipment Management API est incluse dans tous les plans Safecube, sans accès à demander, et s'authentifie avec la clé d'API de l'espace de travail dans l'en-tête API_KEY. Seule l'intégration en iframe d'un lien de partage public reste sur demande.
L'accès est décrit dans Premiers pas avec la Shipment Management API.
Puis-je intégrer le suivi dans une iframe ?
Oui, sur demande. L'intégration en iframe fait partie du pack marque blanche : Safecube doit autoriser le domaine des pages qui intègrent l'iframe, la demande à l'équipe Safecube indique donc ce domaine. La page intégrée est le lien de partage public d'une expédition, renvoyé par la Shipment Management API : en lecture seule, sans connexion, en vue complète ou en vue détail, carte ou liste d'événements.
La demande et l'intégration sont décrites dans Intégrer une expédition dans une iframe.
Que signifie AUTO_CANT_FIND_INFO ?
La Container Tracking API répond 400 avec AUTO_CANT_FIND_INFO quand aucune information n'a pu être détectée automatiquement pour le numéro d'expédition. Relancez la requête avec à la fois le paramètre sealine, le code SCAC de la compagnie, et le paramètre shipmentType. Une requête qui se termine par une erreur 400 ou 500 n'est pas facturée.
Toutes les erreurs sont listées dans Codes d'erreur.