KB0015789: Guide d'utilisation de Postman


Dans cet article, vous apprendrez comment configurer Postman pour les appels tels que GET/POST/PUT/DELETE avec OSS. La documentation suivante fournit des informations supplémentaires sur les appels pris en charge dans l'API REST : Guides des fonctionnalités.

Configuration requise

Assurez-vous que l'application de bureau Postman est installée. L'application peut être téléchargée à partir du lien suivant : https://www.getpostman.com/downloads/.

Appels GET

Un appel GET peut être utilisé pour récupérer des informations, telles que les informations de compte, l'objet du colis ou les approbations de documents.

1. Dans le menu déroulant, sélectionnez « GET ».

2. Saisissez l'URL de la requête. La documentation fournie dans les guides des fonctionnalités répertorie les différents types de requêtes pouvant être envoyées dans OSS.

Dans l'exemple ci-dessous, un appel GET est envoyé pour récupérer la liste des expéditeurs du compte. Le format {environnement}/api/account/senders est utilisé.

3. Accédez à l'onglet « En-têtes » et saisissez les clés et les valeurs requises. Veillez à vérifier dans la documentation les différents en-têtes nécessaires à la requête.

Dans l'exemple ci-dessous, les en-têtes suivants sont requis.

4. Cliquez sur Envoyer.

Les informations demandées s'affichent avec une réponse 200.

Appels POST

Un appel POST peut être utilisé pour créer des données, par exemple pour créer un package.

1. Créer un package sans document

1. Dans le menu déroulant, sélectionnez « POST ».

2. Entrez l'URL de la requête. Le format est le suivant : {environnement}/api/packages.

3. Accédez à l'onglet « En-têtes » et entrez les valeurs suivantes :

4. Accédez à l'onglet « Body » et sélectionnez « raw ».

5. Insérez le JSON minimum pour créer un package, tel qu'un JSON contenant uniquement le nom du package (c'est-à-dire {"name":"test package API"}).

6. Cliquez sur Envoyer.

L'ID du package de la transaction nouvellement créée s'affichera avec une réponse 200.

 

2. Créer un paquet avec un document

1. Dans le menu déroulant, sélectionnez « POST ».

2. Entrez l'URL de la requête. Le format est le suivant : {environnement}/api/packages.

3. Accédez à l'onglet « Headers » (En-têtes) et saisissez les valeurs suivantes :

4. Accédez à l'onglet « Corps » et sélectionnez « form-data ».

5. Sous « Clé », saisissez « fichier » pour télécharger un document, puis modifiez le type de clé en « fichier » dans le menu déroulant. Sous « Value », téléchargez votre document. Remarque : si vous avez plusieurs documents, une nouvelle ligne peut être ajoutée pour chaque document. 6. Sous « Key », tapez « payload » pour télécharger le JSON. À titre d'exemple, vous pouvez utiliser le JSON « CreatePackageWithDocument » ci-joint.

7. Cliquez sur « Send ».

L'ID du package de la transaction nouvellement créée s'affichera avec une réponse 200.

 

Appels PUT

Un appel PUT peut être utilisé pour mettre à jour des données telles que les paramètres du package.

1. Dans le menu déroulant, sélectionnez « PUT ».

2. Entrez l'URL de la requête.

Par exemple, pour mettre à jour un paramètre de package, vous pouvez utiliser le format suivant : {environment}/api/packages/{packageID}

3. Accédez à l'onglet « Headers » (En-têtes) et entrez les valeurs suivantes :

4. Accédez à l'onglet « Body » (Corps) et sélectionnez « raw » (brut).

5. Insérez le JSON mis à jour.

6. Cliquez sur « Envoyer ».

Une réponse 200 sera renvoyée.

Appels DELETE

Un appel DELETE peut être utilisé pour supprimer des informations telles qu'un package.

1. Dans le menu déroulant, sélectionnez « DELETE ».

2. Entrez l'URL de la requête.

Par exemple, pour supprimer un package, vous pouvez utiliser le format suivant : {environnement}/api/packages/{packageID}.

3. Cliquez sur Envoyer.

Une réponse 200 sera renvoyée.