Concepts de l'API Showpad

L'API est utilisée pour s'intégrer aux systèmes Digital Asset Management, à la gestion des utilisateurs et à bien d'autres. Le Showpad API Explorer vous permet d'essayer l' API et vous pouvez y accéder via la Online Platform dans les paramètres administrateur. Cet article va plus profondément dans le monde de l'API Showpad et explique les différentes méthodes et paramètres que vous pouvez utiliser.

Remarque : pour accéder directement à l'API Explorer, accédez à https : // {votresomaine}.Showpad.biz / devportal / explorer

Principales caractéristiques

L'API Showpad est une API client-serveur de RESTful. Essentiellement, le terme REST est utilisé pour indiquer que l'API est basée sur les principes de :

• Envoi d'une requête HTTP et réception d'une réponse HTTP
• Utiliser les verbes HTTP (GET, POST, PUT...)
• Interprétation des codes de réponse HTTP
• Ressources

Remarque : L'URL de base de l'API REST est / API / v {apiVersion}.

Ce qu'il vous faut pour réussir

Voici ce dont vous avez besoin pour créer votre première application qui s'interface avec l'API REST Showpad:

• Plan tarifaire ultime de Showpad
• Accès à Showpad Online Platform
• Connaissance de base de REST
• Connaissance de base de JSON

Les concepts de la génialité

• Emplacement de ressource universel (URL)
• Ressources et liens de ressources
• Méthodes HTTP
• Demander des en-têtes
• Types de médias
• Paramètres de requête
• En-têtes de réponse
• Codes de réponse HTTP

Emplacement de ressource universel (URL)

L'URL identifie la ressource ou la Collection de liens de ressources à laquelle vous souhaitez accéder. Il est structuré comme suit :

/API/ v {apiVersion} / {ressource} [/ {resourceId} [/ {sous-ressource}]] [.JSON]

Voici quelques exemples :

• /API/v1/tags.JSON
• / API / v2 / assets /12345.JSON
• / API / v2 / users /12345/usergroups.JSON

Ressources et liens de ressources

Une réponse de l'API Showpad est basée sur le concept de ressources et de liens de ressources. Une ressource est l'entité centrale de l'API Showpad. Il se caractérise par un identifiant, un type, un ensemble d'attributs et un ensemble de relations avec d'autres ressources.

"réponse" : {
"id" : "279386a847eb5802fc566cb773916d41",
"resourcetype" : "Asset",
"name" : "Showpad One Pager.pdf",
....
étiquettes
"href"https://demo.showpad.biz/api/v3/assets/279386afc566cb773916d41/tags"RL-0
},
"division" : {
"id"4643adcc1621814e91c489b34bb428edID-1",
"href"https://demo.showpad.biz/api/v3/divisions/4643ae91c489b34bb428ed"RL-1
},

Une caractéristique importante de la ressource est son type, identifié par le type de champ. Chaque ressource possède ce champ et il existe 12 types de ressources, distribués à la fois sur le revendeur et sur l'API de la société.

Méthodes HTTP

Dans une configuration d'API REST de base, une requête HTTP est envoyée au serveur Showpad, qui la traite et répond avec une réponse HTTP. La demande elle-même comporte un certain nombre de paramètres importants pour l'API Showpad. Il prend en charge les méthodes HTTP suivantes pour mapper les opérations CRUD (créer, récupérer, mettre à jour, supprimer) aux demandes HTTP. En plus de cela, l'API Showpad prend également en charge les méthodes LINK AND UNLINK pour créer et supprimer des relations entre les ressources :

Remarque : Les utilisateurs n'ont pas accès à tous les actifs à l'aide de l'API REST.

En-tête de demande

Les paramètres d'en-tête sont des paramètres attachés à l'en-tête de la demande. Outre les paramètres d'en-tête standard tels que Content-Type, il existe certains paramètres d'en-tête spécialement conçus pour être utilisés dans l'API Showpad.

Types de médias

Afin de POST ou PUT des données à Showpad, 3 types de contenu différents peuvent être utilisés.

Notes :

• Application / www-url-encoded et multipart / form-data ne peuvent être utilisés que pour ajouter ou mettre à jour une ressource unique.
• Sachez que multipart / form-data n'est valide que pour les requêtes POST.
• Application / JSON peut être utilisé à la fois pour mettre à jour une ressource et créer une ou plusieurs ressources.
• Pour créer une seule ressource, vous utilisez un tableau de valeurs de clé JSON, tandis que lorsque vous souhaitez créer plusieurs ressources par lots, vous utilisez un tableau de tableaux de valeurs de clés JSON.

Paramètres de requête

Les paramètres de requête sont des paramètres attachés à l'URL, généralement après le Parcours de l'URL et encodés sous la forme application / x-www-form-urlencoded. L'exemple ci-dessous montre 3 paramètres : limite et offset.

Selon le type de demande, il existe un certain nombre de paramètres de requête standard :

Le nombre total de correspondances correspondant à votre demande peut être trouvé dans l'attribut « nombre ».

" réponse " :
 {
 " compter " : 29,
 articles
  }

En-têtes de réponse

Les champs d'en-tête suivants sont envoyés pour chaque demande.

Codes de réponse HTTP