Ups Dev Kit User Guide
Ups Dev Kit User Guide
© 2017, United Parcel Service of America, Inc. UPS, le logo UPS et la couleur brune sont des marques de commerce de United Parcel Service of America, Inc. Tous droits réservés.
Guide de l’utilisateur de la trousse de développeur d’UPS
Avant de commencer
Considérations techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Mise en œuvre
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Accès et administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Aperçu du produit
Processus administratifs d’expédition et
de tarification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Processus administratifs de visibilité . . . . . . . . . . . . . . . . . . 28
Processus administratifs de commerce international . . . . 32
Considérations techniques
Avant de télécharger une API, familiarisez-vous avec : Exigences d’accès
• la programmation d’une URL ou des interfaces de Vérifiez si l’API fournit l’accès au test et à la production avec
connexion; la requête de clé d’accès initiale ou si des demandes d’accès
• la création de la mise en œuvre d’une interface de à la production supplémentaires sont nécessaires. Vous
connexion sécurisée compatible avec les normes devez également vérifier si votre modèle de gestion est
actuelles du secteur des cartes de paiement pour les approuvé pour utilisation avec chaque API.
connexions sécurisées; Remarques :
• l’encodage et le décodage de documents XML; • Des codes personnalisés qui adaptent les règles
• la conception et la mise en œuvre d’une stratégie de commerciales et les données de votre application à l’API
gestion d’erreur dans votre logiciel existant. doivent être développés pour intégrer la fonctionnalité des
API dans vos applications de commerce électronique et/ou
Consultez les versions disponibles (XML, services Web
de système administratifs. Un langage de programmation
ou JSON).
compatible avec la communication HTTP à travers
l’interface de connexion Internet et des connexions
sécurisées, tel que Java, Visual Basic ou C++, peut
être utilisé.
• Pour vous aider à intégrer efficacement les API, le présent
guide de l’utilisateur fournit des instructions sur la façon
de télécharger les trousses de développeur à l’adresse
[Link] et de demander un accès aux API. La trousse de
développeur comprend une introduction à toutes les API
ainsi qu’un guide du développeur (avec une Foire aux
questions – Assistance technique).
Introduction
Pour accéder à la Trousse de développeur d’UPS sur le site
Web [Link], saisissez dans le champ Recherche le texte
suivant : « Ressources développeur ». Cliquez sur le lien
Centre de ressources pour développeur. Une fois dans le
Centre de ressources pour développeur, faites défiler vers
le bas jusqu’à l’étape 3 et cliquez sur Accéder à la Trousse
de développeur d’UPS. Vous serez redirigé vers la page
d’application qui vous permettra de télécharger les trousses
de développeur et de demander un accès aux API d’UPS.
Introduction (suite)
Étape 1 : Inscrivez-vous pour créer votre profil [Link].
Si vous êtes déjà inscrit, passez à l’étape 3.
Introduction (suite)
Étape 3 : Sélectionner une API
Sous API de développement, vous trouverez
les exigences pour chaque API dont vous avez
besoin et vous pourrez accéder aux fichiers
téléchargeables et vérifier leur disponibilité pour
chaque pays. Vous pouvez également consulter
la section « Aperçu du produit » de ce guide à
la page 18.
Introduction (suite)
Étape 4 : Télécharger la documentation pour l’API
1. Téléchargez le fichier ZIP pour l’API choisie.
2. Lorsque vous y êtes invité, cliquez sur Sauvegarder.
3. Décompressez le fichier sur l’ordinateur local.
Le fichier téléchargé contient la trousse de développeur de
logiciel. Examinez attentivement l’intégralité du guide du
développeur pour les API que vous allez intégrer. La trousse
de développeur de logiciel comprend également un modèle
de code et des langages WSDL.
Introduction (suite)
UPS fournit un environnement de test accessible par
une clé d’accès pour toutes les API. Ceci vous permettra
de simuler des demandes et des messages de réponse
pour vous assurer que vous avez bien programmé vos
demandes XML ou services Web.
La plupart des API donnent immédiatement accès aux
environnements de test et de production. Cependant,
certaines API pourraient exiger une deuxième demande
pour activer l’accès à la production. Veuillez consulter la
page Web et les avis par courriel qui affichent quelles API
peuvent nécessiter une deuxième demande d’accès à la
production.
Étape 5 : Demander une clé d’accès
Une fois que vous avez examiné la trousse de
développeur de logiciel, vous devez demander
l’accès à l’environnement de test d’UPS.
Vous devrez :
1. Fournir les renseignements du compte.
2. Authentifier les renseignements du compte.
3. Après l’authentification, vous recevrez l’accusé
de réception de votre demande.
Introduction (suite)
Étape 5 : Demander une clé d’accès (suite)
Soumettez les renseignements du compte.
UPS
Jean Dupont
1234, rue de la Montagne
Marketing, Technologie Client
Ville (Province) H0A 0A0
Canada
123 123-4567
123 123-4567
jdupont@[Link]
jdupont@[Link]
Introduction (suite)
Étape 5 : Demander une clé d’accès (suite)
1. Authentifiez le compte.
2. Une fois l’authentification terminée, vous serez
redirigé vers la page de Demande de clé d’accès.
3. Cliquez sur le bouton « Demande de clé d’accès »
en bas.
Remarque : L’authentification de facture du compte (AFC) est
nécessaire pour accéder à vos tarifs négociés via les API pour
le traitement des expéditions et pour l’établissement des
tarifs. Assurez-vous d’avoir en main une copie de l’une de vos
trois plus récentes factures pour authentifier l’AFC.
Introduction (suite)
Étape 5 : Demander une clé d’accès (suite)
Visualisez la confirmation de réception de votre
demande et recevez un courriel de confirmation.
UPS
Jean Dupont
1234, rue de la Montagne
Marketing, Technologie Client
Ville (Province) H0A 0A0
Canada 123 123-4567
123 123-4567
jdupont@[Link]
123 123-4567
jdupont@[Link]
Accès et administration
Afficher ou mettre à jour les clés d’accès
Pour gérer et mettre à jour les clés d’accès, accédez à la page
de la Trousse de développeur d’UPS et sélectionnez Gérer
les clés d’accès dans la section Accès et administration.
123 123-4567
Marketing, Technologie Client
Un nouvel écran apparaîtra pour que vous puissiez 123 123-4567 jdupont@[Link]
123 123-4567
jdupont@[Link]
Processus administratifs
Pays pour lesquels elle est offerte : É.-U. et Puerto Rico pour
d’expédition et de tarification tous les types de transport
Version(s) disponible(s) : XML et JSON
API pour la validation d’adresses Mode(s) disponible(s) : Tous
Exigences d’accès : Une requête d’accès au test
Qu’elle soit intégrée à un site Web ou à un système de
et à la production
commande hors ligne, l’API pour la validation d’adresses
permet aux marchands de comparer les combinaisons ville/
province/code postal fournies par les acheteurs avec celles
des ordinateurs (serveurs) centraux d’UPS. Si la combinaison Limites de l’API
n’est pas valide, UPS renvoie à l’application du marchand une • Ne valide que les adresses des É.-U. et de Puerto Rico
liste de combinaisons ville/province/code postal valides. • Aucune coordonnée de latitude et de longitude fournie dans
UPS fournit jusqu’à dix choix d’adresses. la réponse de l’API
• Ne valide que les combinaisons ville/province/code postal —
Modèles de gestion approuvés
pas la rue
• Validation d’adresses des colis remis à UPS pour livraison
• Ne valide qu’une combinaison ville/province/code postal par
requête
Modèles de gestion/utilisations non approuvés
• La banque d’adresses d’UPS est mise à jour mensuellement
• « Nettoyage » des banques d’adresses
avec les informations fournies par USPS
• Validation d’adresses pour toute utilisation autre que
• N’est PAS un moteur de validation certifié CASS
l’expédition par UPS
• Ne remplace pas le besoin d’un logiciel de validation
d’adresses CASS
Processus administratifs
Pays pour lesquels elle est offerte : É.-U. et Puerto Rico pour
d’expédition et de tarification (suite) tous les types de transport
Version(s) disponible(s) : XML, service Web et JSON
API pour la validation complète d’adresses Mode(s) disponible(s) : Tous
Exigences d’accès : Une requête d’accès au test
Qu’elle soit intégrée à un site Web ou à un système de
et à la production
commande hors ligne, l’API pour la validation complète
d’adresses (VCA) permet aux marchands de comparer les
combinaisons rue/ville/province/code postal fournies par
les acheteurs avec celles des ordinateurs (serveurs) centraux Limites de l’API
d’UPS. Si la combinaison n’est pas valide, UPS renvoie à • Ne valide que les adresses des É.-U. et de Puerto Rico
l’application du marchand une liste de combinaisons rue/ • Ne classe que les adresses (commerciales ou résidentielles)
ville/province/code postal valides. UPS renvoie jusqu’à dix aux É.-U. et au Canada
choix d’adresses.
• Ne valide qu’une combinaison rue/ville/province/code postal
En outre, l’API de VCA classe les adresses commerciales/ par requête
résidentielles pour un certain nombre de pays. Veuillez • Ne valide l’appartement ou la suite que si un numéro
consulter le guide du développeur pour obtenir la liste d’appartement ou de suite est fourni dans la demande de
actuelle (la classification est la classification des activités l’API ou si ce numéro est dans la banque de données d’UPS
internes d’UPS et elle n’est pas fondée sur les renseignements
• Aucune coordonnée de latitude et de longitude fournie dans
du USPS).
la réponse de l’API
Modèles de gestion approuvés • La banque d’adresses d’UPS est mise à jour mensuellement
avec les informations fournies par USPS
• Validation des adresses des colis remis à et livrés par UPS
• N’est PAS une application certifiée CASS
Modèles de gestion/utilisations non approuvés • Ne remplace pas le besoin d’un logiciel de validation
• « Nettoyage » des banques d’adresses d’adresses CASS
• Validation d’adresses pour toute utilisation autre que
l’expédition par UPS
Processus administratifs
Offerte dans 28 pays pour les petits colis seulement
d’expédition et de tarification (suite) Version(s) disponible(s) : XML et JSON
Mode(s) disponible(s) : Colis
API pour la localisation Exigences d’accès : Une requête d’accès au test et à la
production
L’API pour la localisation permet aux utilisateurs de trouver
les points de service UPS locaux à l’aide d’une adresse
ou d’un numéro de téléphone. L’API pour la localisation
fournit les emplacements des points de service UPS à Modèles de gestion approuvés
service complet et libre-service, leurs heures d’ouverture •U
tilisation sur des sites Web marchands et des systèmes
et leur numéro de téléphone. L’API pour la localisation secondaires hors ligne
peut être personnalisée pour présenter l’information
selon différentes configurations qui comprennent Modèles de gestion/utilisations non approuvés
l’emplacement, les services supplémentaires, les types de • Utilisation par des fournisseurs de logistique tiers
programmes, les codes de type et si le point de service
est un détaillant. En outre, l’API pour la localisation fournit Limites de l’API
une carte interactive qui peut afficher jusqu’à dix points • Les coordonnées de latitude et de longitude ne sont pas
de service UPS et des directions routières étape par étape fournies
(si disponibles). • Pas de cartes fournies
Trouvez des emplacements comme :
• Points d’accès UPS®
• The UPS Store®
• Mail Boxes Etc.®
• Grâce à nos 400 points de dépôt libre-service partout au
Canada, expédier par UPS est simple et pratique.
• Centres de service aux clients UPS
• UPS Express®
• Chaînes de magasins
• Point de vente autorisé (ASO) UPS
• Fournisseurs de services UPS autorisés
Processus administratifs
Offerte dans 39 pays pour les colis et le fret en chargement
d’expédition et de tarification (suite) partiel (LTL) (Gemini pour le fret aérien)
Version(s) disponible(s) : XML, service Web et JSON
API pour le traitement des ramassages Mode(s) disponible(s) : Colis et fret en chargement partiel (LTL)
(Gemini pour le fret aérien)
L’API pour le traitement des ramassages permet à
Exigences d’accès : Une demande pour l’accès au test et
l’utilisateur de planifier un ramassage UPS à partir de la à la production de l’API de traitement
maison ou du bureau. Les utilisateurs peuvent également des ramassages de petits colis, deux
planifier le ramassage d’un colis, un envoi de fret ou demandes séparées pour l’API de
un nouvel envoi. En outre, des options de ramassage traitement des ramassages de fret
respectueuses de l’environnement d’UPS sont offertes sur terrestre
l’API pour le traitement des ramassages de petits colis.
Limites de l’API
• Aucune
Processus administratifs
Offerte dans 31 pays pour les petits colis
d’expédition et de tarification (suite) Version(s) disponible(s) : Service Web et JSON
Mode(s) disponible(s) : Colis
API pour les préavis Exigences d’accès : Une requête d’accès au test et à la
production
L’API pour les préavis permet aux applications du client
d’informer les activités d’UPS des envois de marchandises
dangereuses qui ont été traités et qui entreront dans
le réseau de transport d’UPS avant le téléchargement Modèles de gestion approuvés
des données du manifeste à la fin de la journée. Cela • Utilisation avec les systèmes de gestion des manifestes
contribuera à améliorer la manipulation et à réduire les afin d’aviser UPS d’envois de marchandises dangereuses
retards pour les envois de marchandises dangereuses. entièrement réglementées traités
L’API pour les préavis peut être utilisée conjointement
avec d’autres API après qu’un envoi de marchandises Modèles de gestion/utilisations non approuvés
dangereuses a été traité. • Aucune
Enfin, l’utilisation de cette API sera exigée aux clients ayant
un contrat portant sur les marchandises dangereuses et qui Limites de l’API
envoient des chargements de marchandises dangereuses • Aucune
ou qui expédient des marchandises dangereuses par
transport routier en Europe (Accord européen relatif au
transport international des marchandises dangereuses par
route ou ADR).
Voici les fonctionnalités incluses :
• Notification d’UPS des envois de marchandises
dangereuses dès que l’envoi est traité.
• Notification d’UPS des envois de marchandises
dangereuses annulés.
En outre, les codes personnalisés qui adaptent les données
et les règles d’affaires de votre application d’entreprise
à l’API doivent être mis au point pour intégrer cette
fonctionnalité de l’API à vos systèmes opérationnels.
Processus administratifs
Offerte dans 103 pays pour les petits colis, dans 4 pays pour le fret
d’expédition et de tarification (suite) LTL et dans 36 pays pour le fret aérien (API Gemini)
Version(s) disponible(s) : XML, service Web et JSON (voir les
remarques)
API pour l’établissement des tarifs
Mode(s) disponible(s) : Colis, fret LTL (1), fret aérien (2)
L’API pour l’établissement des tarifs fournit la tarification
Exigences d’accès : Deux demandes séparées pour l’accès
(ramassage quotidien, sur demande ou chez le détaillant) au test et à la production du fret LTL et
pour les niveaux de services de petit colis UPS et Fret demande manuelle pour le fret aérien
UPS® LTL offerts vers toute destination servie par UPS. avec le formulaire de demande des
L’API pour l’établissement des tarifs peut être configurée API Gemini (voir les liens dans la trousse
pour présenter tous les tarifs offerts (option « Magasin ») de développeur d’UPS sur [Link])
ou les tarifs de niveaux de service spécifiques (option
« Tarif »). Les tarifs publiés sont fournis par défaut; les tarifs
négociés propres au compte peuvent être activés par Remarques :
l’Authentification de facture du compte depuis les pages (1) Service Web seulement pour le fret LTL
Sommaire du compte ou Tenue de compte à l’adresse ups. (2) Fret aérien seulement depuis les API Gemini XML
com. Consultez la page 11 de ce guide pour plus de détails.
L’API pour l’établissement des tarifs fournit la date et l’heure
de livraison pour tous les services sauf Standard (l’API pour
le calcul des délais de livraison doit être utilisée pour obtenir
cette information).
Limites de l’API
Modèles de gestion approuvés • La tarification du fret aérien requiert l’utilisation des
• Utilisation sur des sites Web marchands et des systèmes API Gemini. Veuillez consulter la page d’accueil de la
secondaires hors ligne trousse de développeur d’UPS ainsi que la section des
annonces et mises à jour d’API pour un lien vers le
Modèles de gestion/utilisations non approuvés formulaire de demande des API Gemini et le guide du
développeur. Veuillez lire attentivement le formulaire de
• Affichage parallèle des tarifs d’UPS et des tarifs
demande pour obtenir l’accès à cette API.
concurrents
L’API pour l’établissement des tarifs prend en charge
l’établissement des tarifs des marchandises dangereuses.
Processus administratifs Offerte dans 103 pays pour les petits colis, dans 4 pays pour le fret LTL
d’expédition et de tarification (suite) et dans 36 pays pour le fret aérien (API Gemini)
Version(s) disponible(s) : XML et services Web (voir remarques)
API pour le traitement des envois Mode(s) disponible(s) : Colis, fret LTL (1), fret aérien (2)
Exigences d’accès : Deux demandes séparées pour l’accès
L’API pour le traitement des envois prend en charge au test et à la production du fret LTL et
l’intégration de la fonctionnalité d’expédition d’UPS sur demande manuelle pour le fret aérien
l’ensemble des systèmes et sites Web de l’entreprise. avec le formulaire de demande des API
L’intégration permet l’utilisation de données des Gemini (voir les liens dans la trousse de
applications de l’expéditeur sans saisie de la part de développeur d’UPS sur [Link])
l’utilisateur tout en prenant en charge les processus
internes grâce à un accès à l’expédition pratique et contrôlé.
L’API pour le traitement des envois prend aussi en charge Remarques :
l’éventail complet des retours de petits colis UPS Returns®, (1) Service Web et JSON pour le fret LTL
y compris les retours internationaux. La classification UPS (2) Fret aérien seulement depuis les API Gemini XML
des adresses résidentielles et commerciales ainsi que la
validation ville, province et code postal sont aussi fournies.
L’intégration de l’API pour le traitement des envois d’UPS
requiert un temps et une expérience de programmation
considérables.
Processus administratifs
d’expédition et de tarification (suite)
API pour le traitement des envois (suite)
Limites de l’API
• Ne sont pas pris en charge : Fonctionnalités World Ease®,
traitement par lots et Services UPS Hundredweight®
Processus administratifs
Offerte dans 103 pays pour les petits colis seulement
d’expédition et de tarification (suite) Version(s) disponible(s) : XML, service Web et JSON
Mode(s) disponible(s) : Colis
API pour le calcul des délais de livraison Exigences d’accès : Une demande pour l’accès au test et à la
production pour les modèles de gestion
L’API pour le calcul des délais de livraison permet aux
approuvés par UPS
utilisateurs de comparer la rapidité de livraison de
différents services de façon à ce qu’ils puissent choisir le
service le plus approprié pour leur envoi. Cet outil offre
des renseignements sur tous les services d’expédition
offerts par UPS, partout dans le monde. On retrouve parmi
les renseignements fournis la date, l’heure et le délai de
livraison. L’API fournit la date et l’heure de livraison des colis
expédiés par voie terrestre en tenant compte des jours
fériés d’UPS et des fins de semaine.
Limites de l’API
• Aucune
Processus administratifs de
Offerte dans 31 pays pour les petits colis seulement
visibilité Version(s) disponible(s) : XML et JSON
Mode(s) disponible(s) : Colis
API pour Quantum View ®
Exigences d’accès : Une requête d’accès au test et à la
production
Les données Quantum View fournissent des ®
Signets
Comprendre les services Quantum View XML
Pour les utilisateurs avec un haut volume d’activité et afin
Les renseignements Quantum View sont présentés comme de diminuer la pression sur les ressources du réseau, l’API
des « événements ». Avec cette API, votre application peut pour Quantum View peut limiter la quantité d’information
récupérer automatiquement les événements Quantum View renvoyée pour toute demande. Cette limite est d’environ
et les intégrer dans les autres processus de votre système. 150 Ko pour les fichiers multiples combinés ou 500 Ko pour
un seul fichier. Pour les fichiers qui dépassent la limite, UPS
envoie une partie de l’information et joint un signet spécial
à la réponse. Pour récupérer l’information supplémentaire,
transmettez de nouveau la demande originale en ajoutant le
signet spécial.
Processus administratifs de
visibilité (suite)
API pour Quantum View (suite)
Format d’information
Lorsque votre application demande les événements
Quantum View, l’API n’envoie que les événements qui n’ont
pas déjà été visionnés. Les demandes de noms de fichier
ou de date/heure sont les seules exceptions à cette règle.
Limites de l’API
• Les mises à jour sont effectuées par lots et sont effectuée
toutes les 30 minutes au maximum
• Les fichiers doivent être annexés aux données existantes
de façon à ce que seuls les changements soient inclus
dans les fichiers horaires de mise à jour
• Seuls le manifeste, les exceptions et les numérisations de
livraison sont fournis dans le fichier. Aucune numérisation
intermédiaire (en transit)
Processus administratifs de
Offerte dans 103 pays pour tous les moyens de transport
visibilité (suite) Version(s) disponible(s) : XML, service Web et JSON
Mode(s) disponible(s) : Tous
API pour le suivi des envois Exigences d’accès : Une requête d’accès au test et à la
production
L’API pour le suivi des envois permet aux clients de suivre
leurs envois de façon transparente à partir d’un site de
commerce électronique par un numéro de référence ou
de commande. Vos clients peuvent consulter des détails Limites de l’API
spécifiques sur le statut de leur envoi, comprenant l’heure • Limite de 64 Ko par réponse, peu importe la taille de l’envoi
et le lieu de chaque numérisation jusqu’à ce que le colis
• Les envois de 50 colis peuvent ne renvoyer que
arrive à sa destination finale. De plus, les renseignements
l’information des 15 premiers colis selon la disponibilité
de suivi peuvent s’harmoniser parfaitement avec
des renseignements de suivi
l’apparence de votre site.
• Transactionnel, non pas par lot et aucun téléchargement
Modèles de gestion approuvés par lot des numéros de suivi
• Utilisation sur des sites Web marchands et des systèmes • L’API ne fait le suivi que d’un seul numéro de suivi ou de
secondaires hors ligne référence pour chaque demande
• Les numérisations de colis et l’information de poids sont
Modèles de gestion/utilisations non approuvés disponibles durant six mois
• Utilisation par des fournisseurs de logistique tiers qui ne • Le suivi du numéro de référence est disponible durant
font pas partie de la transaction quatre mois
• Utilisation par des « robots » qui font le suivi de chaque • L’information de numérisation de livraison est disponible
colis sortant jusqu’à un événement spécifique durant 18 mois
Processus administratifs de
Offerte dans 45 pays pour les petits colis seulement
visibilité (suite) Version(s) disponible(s) : XML, service Web et JSON
Mode(s) disponible(s) : Colis seulement
API pour UPS Signature Tracking ®
Exigences d’accès : Une demande pour l’accès au test et à la
production pour les modèles de gestion
L’API pour UPS Signature Tracking fournit la même
approuvés par UPS
information que l’API pour le suivi des envois plus :
• le nom et l’adresse du destinataire;
• le montant reçu en envoi CR; Modèles de gestion approuvés
• l’image de la signature en tant que preuve de • Utilisation sur des sites Web marchands et des systèmes
livraison (POD). secondaires hors ligne
Les marchands peuvent intégrer l’image d’une lettre de Modèles de gestion/utilisations non approuvés
POD à leur système pour l’envoyer automatiquement par
• Utilisation par des fournisseurs de logistique tiers qui ne
courriel, par la poste ou par télécopieur aux acheteurs
font pas partie de la transaction
de façon proactive ou en réponse aux plaintes de non-
paiement ou aux demandes de POD. Puisque la lettre • Utilisation par des « robots » qui font le suivi de chaque
de POD inclut la signature du destinataire (obtenue au colis sortant jusqu’à un événement spécifique
moment de la livraison), cette solution peut convenir aux
acheteurs non satisfaits de l’information de signature Limites de l’API
« clarifiée » (saisie par le chauffeur UPS) fournie par l’API • Identiques à celles de l’API pour le suivi des envois
pour le suivi des envois standard. • Limites supplémentaires pour le stockage des signatures
Remarque : Les demandes de traitement nécessitent pendant 18 mois
l’inclusion du numéro de compte. Les numéros de suivi
générés par d’autres comptes ne fonctionneront pas à moins
que ces comptes soient ajoutés au sommaire du compte de
l’identifiant Mon UPS inclus pour l’identifiant Mon UPS utilisé
dans la demande XML.
Processus administratifs de
Offerte dans 68 pays pour les petits colis
commerce international Version(s) disponible(s) : Service Web et JSON
Mode(s) disponible(s) : Petits colis
API pour document électronique Exigences d’accès : Demande unique pour l’accès au test
et à la production pour les modèles de
L’API pour document électronique vous donne la possibilité
gestion approuvés par UPS
de télécharger l’image de vos documents avec vos envois.
Ceci élimine le besoin d’apposer sur le colis les documents
d’expédition papier et évite ainsi des problèmes de
retards de traitement. Cet outil est utilisé en conjonction Comprendre le traitement de l’API pour document
avec d’autres systèmes de manifestes ainsi que l’API électronique
pour le traitement des envois. Cette capacité élimine • Le service Web de l’API pour document électronique
essentiellement le problème des documents perdus ou comprend trois opérations :
endommagés et permet une liaison automatique et sans 1. Mise en ligne des documents vers l’historique des
difficulté des envois et de l’image de leurs documents formulaires (voir les limites de l’API en page 33).
nécessaire pour le traitement.
2. Suppression des documents mis en ligne
Remarque : Vous devez posséder un numéro de compte à (un identifiant de document par demande de
6 chiffres valide et votre compte doit être activé par votre suppression).
gestionnaire de compte UPS dans les systèmes secondaires 3. Déplacement des documents mis en ligne vers le
d’UPS pour pouvoir utiliser Télécharger mes formulaires répertoire d’images.
sur [Link] ou l’API pour document électronique. Si le
numéro d’expéditeur n’est pas activé dans les systèmes Remarque : Vous devrez mettre au point des écrans de
secondaires pour le téléchargement des formulaires, saisie qui collectent l’information requise par l’application
l’API pour document électronique rencontrera une erreur pour initialiser les demandes de mise en ligne, suppression
récurrente. et déplacement des images de documents créées.
Processus administratifs de
Offerte dans 34 pays pour les petits colis
commerce international (suite) Version(s) disponible(s) : Service Web et JSON
Mode(s) disponible(s) : Colis
API pour UPS TradeAbility ®
Exigences d’accès : Demande unique pour l’accès au test
et à la production pour les modèles de
La série UPS TradeAbility de services axés sur l’information
gestion approuvés par UPS
permet la gestion efficace du mouvement des biens
à travers les frontières internationales. L’API pour
UPS TradeAbility peut améliorer la conformité aux
• API pour la filtration de parties refusées
règlements, réduire les dépenses d’exploitation et simplifier
Détermine à partir d’une seule source les personnes qui
les chaînes d’approvisionnement mondiales ainsi que les
sont sur les listes de surveillance du gouvernement des
processus de commerce international.
É.-U. afin d’assurer une conformité actuelle et précise
• API pour le calcul du coût au débarquement avec la réglementation gouvernementale. Permet des
Estime le coût des envois internationaux : y compris les transactions uniques et la sélection de différents réglages
droits, les frais et taxes de douanes. Des droits de douane pour permettre des recherches plus larges et vérifie une
préférentiels peuvent être inclus dans les évaluations du source unique pour les parties nommées et les pays de
coût au débarquement par défaut. Pour que ces tarifs destination en plus de fournir des raisons spécifiques de
soient appliqués lors de l’expédition, l’expéditeur doit refus et de citer les sources.
soumettre la documentation appropriée avec l’envoi. • API pour la conformité aux règles d’importation
Permet des transactions contenant jusqu’à 99 produits Réduisez les retards à la frontière en vous conformant le
par envoi à partir d’un pays d’origine jusqu’à un pays plus possible aux règlements, procédures et restrictions
de destination. Afin de fournir l’estimation de coût au propres à chaque pays avant d’importer. Les détails des
débarquement le plus précis, le service peut affiner transactions de conformité aux règles d’importation seront
son estimation à l’aide d’une série de questions et de enregistrés et sont accessibles pendant 90 jours. Permet
réponses interactives grâce à l’élément QueryRequest. des transactions contenant jusqu’à 99 produits par envoi
L’utilisateur retransmet la question en incluant la d’un pays d’origine à un pays de destination.
réponse en utilisant les éléments EstimateRequest. Une • API pour la détection de permis d’exportation
fois qu’UPS a reçu toute l’information nécessaire, une Accède aux exigences actuelles des permis d’exportation
estimation du coût au débarquement est fournie. des É.-U. selon le pays de destination ou l’information
sur les produits, comme le numéro de classification
d’exportation, pour réduire les risques d’amendes et de
sanctions.
Processus administratifs de
commerce international (suite)
API pour UPS TradeAbility (suite)
Limites de l’API
• Aucune fonctionnalité de recherche de codes harmonisés
Ressources
Suivez les trois étapes clés (et les liens connexes) ainsi
que les liens pour accéder à l’assistance technique et à la
communauté de la Trousse de développeur d’UPS par le
Centre de ressources pour développeur UPS.
Étape 1 : Intégration/Planification
En savoir plus sur l’intégration des API de la Trousse de
développeur d’UPS
Planifier l’intégration
Lire les directives à l’intention des développeurs
Voir la liste des API proposées
Étape 2 : Pour débuter/Directives
Découvrir comment accéder aux serveurs de la Trousse
de développeur d’UPS pour effectuer des tests et traiter
avec UPS.
Afficher le Guide de l’utilisateur de la Trousse de
développeur d’UPS
Afficher le Guide de référence rapide
Consulter la foire aux questions sur la trousse de
développeur
Étape 3 : Développeurs : Télécharger les API
Obtenir et gérer l’authentifiant de l’API et télécharger les
trousses de développeur.
Accéder à la Trousse de développeur d’UPS
Accéder aux téléchargements de Gemini et à la trousse
d’outils
Assistance technique
Il existe quatre façons d’obtenir de l’assistance pour les
API de la trousse de développeur d’UPS, toutes accessibles
depuis le centre de ressources du développeur d’UPS.
Les instructions sur l’accès au centre de ressources du
développeur d’UPS se trouvent à la page 40.
privilégiée)
Il s’agit de l’option d’aide pour l’assistance technique
et les questions au sujet de l’intégration des API. Vous
pouvez y accéder en ouvrant une session et en joignant
vos fichiers Question/Réponse XML ainsi que toute autre
information pertinente au sujet de votre intégration. Le
soutien technique par courriel d’UPS ne peut prendre en
charge que la paire Question/Réponse XML. L’assistance
technique ne peut pas conseiller les clients et les
développeurs au sujet de la manière d’intégrer XML à leur
logiciel interne ou acheté.
Assistance d’escalade
• Les heures de service sont de 8 h à 20 h HE, du lundi au
vendredi
• Le délai de réponse devrait être de moins de 24 heures
pendant les heures de service normales
• Fermé les fins de semaine et les jours fériés d’UPS