Showpad-API-Konzepte

Die API wird zur Integration mit Digital-Asset-Management-Systemen, Nutzerverwaltung und vielem mehr verwendet. Mit dem Showpad-API Explorer können Sie die API ausprobieren und über die Online Platform in den Admin-Einstellungen darauf zugreifen. Dieser Artikel taucht tiefer in die Welt der Showpad-API ein und erläutert die verschiedenen Methoden und Parameter, die Sie verwenden können.

Hinweis: Um direkt auf den API Explorer zuzugreifen, rufen Sie https://{IhreSubdomain}.Showpad.biz/devportal/explorer auf

Hauptmerkmale

Die Showpad-API ist eine RESTful-Client-Server-API. Der Begriff REST wird im Wesentlichen verwendet, um anzuzeigen, dass die API auf den folgenden Prinzipien basiert:

• Senden einer HTTP-Anfrage und Empfangen einer HTTP-Antwort
• Verwendung von HTTP-Verben (GET, POST, PUT...)
• Interpretieren von HTTP-Antwortcodes
• Ressourcen

Anmerkung: Die Basis-URL für die REST-API lautet /API/v{apiVersion}.

Was Sie für den Erfolg benötigen

Sie benötigen Folgendes, um Ihre erste App zu erstellen, die mit der Showpad-REST-API kompatibel ist:

• Den Ultimate-Preisplan von Showpad
• Zugriff auf die Showpad Online Platform
• Grundkenntnisse in REST
• Grundkenntnisse in JSON

Die Konzepte der Großartigkeit

• Universal Resource Location (URL)
• Ressourcen und Ressourcenlinks
• HTTP-Methoden
• Header anfordern
• Medientypen
• Abfrageparameter
• Antwort-Header
• HTTP-Antwortcodes

Universal Resource Location (URL)

Die URL gibt an, auf welche Ressource oder Sammlung von Ressourcenlinks Sie zugreifen möchten. Sie ist wie folgt aufgebaut:

/API/v{apiVersion}/{resource}[/{resourceId}[/{subResource}]][.JSON]

Nachfolgend einige Beispiele:

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

Ressourcen und Ressourcenlinks

Eine Antwort von der Showpad-API basiert auf dem Konzept von Ressourcen und Ressourcenverknüpfungen. Eine Ressource ist die Zentraleinheit innerhalb der Showpad-API. Sie ist gekennzeichnet durch eine ID, einen Typ, eine Reihe von Attributen und eine Reihe von Beziehungen zu anderen Ressourcen.

"response": {
"id": "279386a847eb5802fc566cb773916d41",
"resourcetype": "Asset",
"name": "Showpad One Pager.pdf",
....
"tags": {
"hrefhttps://demo.showpad.biz/api/v3/assets/279386afc566cb773916d41/tags"RL-0
},
"division": {
"id4643adcc1621814e91c489b34bb428edID-1",
"hrefhttps://demo.showpad.biz/api/v3/divisions/4643ae91c489b34bb428ed"RL-1
},

Ein wichtiges Merkmal der Ressource ist der Typ, der durch das Feld „Ressourcentyp“ identifiziert wird. Jede Ressource hat dieses Feld und es gibt 12 Ressourcentypen, die sowohl auf den Reseller als auch auf die Unternehmens-API verteilt sind.

HTTP-Methoden

In einer einfachen REST-API-Konfiguration wird eine HTTP-Anfrage an den Showpad-Server gesendet, der die Anfrage verarbeitet und mit einer HTTP-Antwort antwortet. Die Anforderung selbst enthält eine Reihe von Parametern, die für die Showpad-API wichtig sind. Es werden die folgenden HTTP-Methoden unterstützt, um CRUD-Vorgänge (Create - Datensatz anlegen, Retrieve - Datensatz lesen, Update - Datensatz aktualisieren, Delete - Datensatz löschen) HTTP-Anforderungen zuzuordnen. Darüber hinaus unterstützt die Showpad-API die LINK- UND UNLINK-Methoden zum Erstellen und Löschen von Beziehungen zwischen Ressourcen:

Hinweis: Nutzer haben bei der Verwendung der REST-API keinen Zugriff auf alle Assets.

Header anfordern

Header-Parameter sind Parameter, die an den Header der Anforderung angehängt sind. Neben den Standard-Header-Parametern wie Content-Type gibt es einige Header-Parameter, die speziell für die Verwendung in der Showpad-API entwickelt wurden.

Medientypen

Um Daten auf Showpad mit POST oder PUT zu verarbeiten, können 3 verschiedene Inhaltstypen verwendet werden.

Hinweise:

• Application/www-url-encoded und multipart/form-data können nur zum Hinzufügen oder Aktualisieren einer einzelnen Ressource verwendet werden.
• Beachten Sie, dass multipart/form-data nur für POST-Anfragen gültig sind.
• Application/JSON kann sowohl zum Aktualisieren einer einzelnen Ressource als auch zum Erstellen einer oder mehrerer Ressourcen verwendet werden.
• Um eine einzelne Ressource zu erstellen, verwenden Sie ein JSON-Schlüsselwert-Array. Wenn Sie mehrere Ressourcen im Batch erstellen möchten, verwenden Sie ein Array der JSON-Schlüsselwert-Arrays.

Abfrageparameter

Abfrageparameter sind Parameter, die an die URL angehängt werden, normalerweise nach dem Pfad der URL. Sie sind als „application/x-www-form-urlencoded“ codiert. Das folgende Beispiel zeigt 3 Parameter: Limit und Offset.

Abhängig von der Art der Anfrage gibt es eine Reihe von Standard-Abfrageparametern:

Die Anzahl der Übereinstimmungen, die Ihrer Anfrage entsprechen, finden Sie im Attribut „count“.

"response":
 {
 "count": 29,
 "items": [...]
  }

Antwort-Header

Die folgenden Headerfelder werden für jede Anfrage gesendet.

HTTP-Antwortcodes