Action d'API personnalisée

Adressez une requête HTTP authentifiée à l'API DocuSign.

Options

Champ Définition Type Obligatoire

Type de requête

Il s'agit de l'une des méthodes de requête HTTP prises en charge, ou de verbes HTTP, dans un appel d'API personnalisé (consultez Méthodes de requête HTTP).

  • GET : récupère des données d'un serveur Web en fonction des paramètres. Cette méthode demande une représentation de la ressource spécifiée. Si une requête aboutit, un message de réponse 200 (OK) est renvoyé avec le contenu demandé.
  • POST : envoie des données à un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Plusieurs requêtes POST peuvent produire un résultat différent de celui d'une seule requête POST. Il faut être prudent pour éviter d'envoyer plusieurs requêtes POST par inadvertance. Si une requête aboutit, un message de réponse 200 (OK) est renvoyé.
  • PUT : envoie des données à stocker à un emplacement spécifique sur un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Contrairement aux requêtes POST, les requêtes PUT sont idempotentes. Pour les requêtes réussies, le résultat d'une seule requête PUT est le même que plusieurs requêtes PUT identiques. Si une requête réussit, un message de réponse 200 (OK), 201 (Created) ou 204 (No Content) est retourné.
  • PATCH : applique des modifications partielles à une ressource sur un serveur Web en fonction des paramètres. PATCH n'est pas idempotent. Plusieurs requêtes PATCH pourraient avoir des conséquences non souhaitées. Si une requête PATCH réussit, un message de réponse 200 (OK) ou 204 (No Content) est renvoyé.
  • DELETE : supprime la ressource spécifiée (si elle existe) du serveur Web en fonction des paramètres. Si une requête DELETE aboutit, un message de réponse 200 (OK) est renvoyé.
Liste déroulante TRUE

Sélectionner l'API

Choisissez eSignature API ou Admin API.

 Liste déroulante TRUE

Comptes

Choisissez parmi les comptes DocuSign disponibles.

 Liste déroulante TRUE

Entrée

Champ Définition Type Obligatoire

URL liée

L'adresse (URL) du serveur Web que vous essayez d'appeler. Définir l'URL relative comme suit : /{version}/{insert_remaining_URL}. Utilisez une barre oblique au début de l'URL liée.

Vous pouvez spécifier les paramètres de la requête dans l'URL liée en utilisant « ? » ou spécifier les paramètres de la requête comme une paire de clés de l'objet dans l'entrée de requête.

Par exemple, pour un point de terminaison de l'API DocuSign https://api.docusign.net/management/v2/organizations, l'URL relative est /organizations.

 Texte TRUE

Requête

Objet JSON qui détermine l'action entreprise au niveau de l'URL.

Objet ou texte

 FALSE

En-têtes

Objet JSON qui détermine le type de contenu de la requête.

 Objet FALSE

Sortie

Champ Définition Type

Réponse

Code de statut

Résultat de l'opération. Le connecteur retourne un code de statut HTTP qui indique si l'action effectuée par la carte a réussi ou échoué. Par exemple :

  • Un code de statut 201 Created indique un succès où une nouvelle ressource a été créée.
  • Une erreur 403 Forbidden indique que la requête HTTP n'a pas été traitée parce que les permissions nécessaires étaient manquantes.

Pour une liste complète des codes de statut possibles, voir Codes de statut HTTP.

 Nombre

En-têtes

Contexte détaillé du code de statut, sans lien avec le corps de la sortie. Les en-têtes de réponse dépendent de l'option de requête HTTP sélectionnée. Tous les en-têtes ne sont pas des en-têtes de réponse. Ceci est semblable à {"Content-type":"application/json"}.

 Objet

Corps

Données retournées par votre requête HTTP sélectionnée.

Par exemple, les données d'une requête GET.

 Objet