Was ist für Sie drin?
Um zu sehen, was Sie mit der Showpad-API tun können, geben wir einige Beispiele, die Sie beim Erstellen Ihrer Kreation inspirieren und unterstützen können.
Hinweis: Verwenden Sie den API Explorer auf Showpads Online Platform, um eine Liste aller verfügbaren Parameter anzuzeigen. Sie finden es auf der Registerkarte API in den Admin-Einstellungen.
Was Sie für den Erfolg benötigen
- Showpads ultimativer Preisplan
- Zugriff auf die Online Platform von Showpad
- Grundkenntnisse in REST
- Grundkenntnisse in JSON
- Erstellen einer PDF-Datei mit einem Tag
- Asset-Link erstellen
- Benutzerinformationen abrufen
- Rückgabe einer Reihe von Benutzern
- Inhalt an persönliche Meine Dateien/ Mein Upload-Ordner des Benutzers senden
- Assets und Tags optimal erstellen
- Erstellen Sie ein Asset über die API über Post /assets.json und rufen Sie die Antwort-ID ab.
- Kopieren Sie diese Antwort-ID und gehen Sie zu Tickets.
- Wählen Sie: GET/tickets/id.json und geben Sie die generierte ID ein
- Sie erhalten eine Antwort mit der ID des Assets:
"asset": {"id": "xxxxx", - Erstellen Sie ein Tag über POST /tags.JSON oder suchen Sie die Tag-ID über Get / TAGS.JSON.
- Kopieren Sie diese Tag-ID.
- Gehen Sie zu Tags LINK / tags / id.JSON.
- Als ID-Wert geben Sie die ID der Variablen ein.
- Als Link-Wert geben Sie ' < Asset-ID hinzufügen > ; rel = "Asset" '
Der Link zu einem Asset kann über unsere öffentliche API mit dem Aufruf GET ASSET BY ID abgerufen werden:
https://yoursubdomain.showpad.biz/api/v2/assets/0a7c4def949d4da0d461a.json
Die Antwort dieses Aufrufs enthält das appLink-Attribut:
{
„meta“: {
„code“: 200,
„message“: „OK“,
„serverTime“: „2014-06-10 09:19: 1“,
"lastUpdatedTime": "2014-06-10 09:19: 15",
"requestRateLimit": 5000,
"requestRateLimitReset": 86400,
"requestsRemaining": 4987
},
"response": {
"id": "0a7c4def949d4da0d461a842",
"resourcetype": "Asset",
"name": "name.jpg",
"originalName": "orgname.jpg",
"description": null,
"filetype": "photo",
"Download-Link":
"https://yoursubdomain.showpad.biz/api/v2/assets/0a7c4def949d4da0d461a/file",
"previewDownloadLink":
"https://yoursubdomain.showpad.biz/api/v2/assets/0a7c4def949d4da0d461a/preview",
"isSensitive": false,
"isAnnotatable": true,
"isShareable": true,
"fileSize": 364485,
"views": 0,
"averageRating": 0,
"externalId": null,
"createdAt": "2013-07-01 07:32: 04",
"updatedAt": "2013-09-05 06:14: 50",
"appLink": "Showpad: // file /02fb913985a38f5ad5ebcf95183792c0",
"tags": {
"href":
"https://yoursubdomain.showpad.biz/api/v2/assets/0a7c4def94d4da0d461a/tags"
},
"division": {
"id": "4643adcc1621814e91c489b34bb428ed",
"href":
"https://yoursubdomain.showpad.biz/api/v2/divisions/4643adcc1681434bb428ed"
}
}
}
Diese Slugs funktionieren auf Showpad unter iOS 3.4.2 und Android 1.5.1.
Unten sehen Sie ein Beispiel für eine GET / users /12345.JSON.
{
„meta“: {
„code“: 200,
„message“: „OK“,
„serverTime“: „2017-09-30 11:02: 39“,
„lastUpdatedTime“: „2017-09-30 11:02: 39“,
„requestRateLimit“: 5000,
"requestRateLimitReset": 86400,
"requestsRemaining": 4975
},
"response": {
"id": "12345",
"resourcetype": "Benutzer",
"firstName": "Nettie",
"lastName": "Pierce",
"E-mail": "nettie@mycompany.com",
"userName": "nettie@mycompany.com",
"language": "en_US",
"userType": "owner",
"apiKey": "someApiKeyWithNumbersAndLetters",
"externalId": null,
"lastLogin": "2017-09-30 10:58: 38",
"letztesbestätigtesContentUpdate": null,
"isActive": wahr,
"createdAt": "2017-09-29 13:03: 31",
"updatedAt": "2017-09-30 10:58: 38",
"usergroups": {
"href": "https://my-subdomain.showpad.biz/api/v2/users/12345/usergroups"
},
"tabletpermission": null
}
Die Antwort besteht aus zwei unterschiedlichen Teilen:
- Meta: Enthält den Antwortcode, die Nachricht und die Uhrzeit des Servers
- Antwort: Enthält die tatsächliche Ressource einschließlich ID, Typ, Attributen und Beziehungen
Rückgabe eines Arrays von Benutzern
Die Showpad-API verwendet auch das Konzept der Ressourcenverknüpfungen. Wenn eine Sammlung von Ressourcen angefordert wird (z. B. über GET /users.JSON), wird ein Array von Benutzern zurückgegeben, wie im folgenden Beispiel gezeigt:
{
"meta": {
"code": 200,
"message": "OK",
"serverTime": "2017-09-30 11:01: 08",
"lastUpdatedTime": "2017-09-30 11:01: 08",
"requestRateLimit": 5000,
"requestRateLimitReset": 86400,
"Anfragen Verbleibend": 4975
},
"response": {
"count": 2,
"items": [
{
"id": "12345",
"resourcetype": "Benutzer",
"href": "https://my-subdomain.showpad.biz/api/v2/users/12345",
"username": "nettie@mycompany.com"
},
{
"id": "123456",
"resourcetype": "Benutzer",
"href": "https://my-subdomain.showpad.biz/api/v2/users/123456",
"username": "elsabeth@mycompany.com"
}
]
}
}
Die Antwort besteht aus zwei Teilen:
- Meta: Enthält den Antwortcode, die Nachricht und die Uhrzeit des Servers
- Antwort: Enthält die Gesamtanzahl in dieser Sammlung und ein Array von Ressourcenverknüpfungen. Jeder Ressourcenlink enthält eine ID, einen Ressourcentyp, den Speicherort der Ressource und einige optionale Attribute. Beachten Sie, dass die Anzahl in der Antwort die Gesamtanzahl der Ergebnisse und nicht die Anzahl der Seiten ist. Wenn zum Beispiel 50 Benutzer vorhanden sind und das Limit dieser Seite 25 beträgt, beträgt die Anzahl 50 und nicht 25.
Übertragen von Inhalten in den persönlichen Ordner " Meine Dateien " eines Benutzers
Mit der Showpad-API können Sie Inhalte in den Ordner "Meine Uploads" der Benutzer verschieben. Dazu sind folgende Komponenten erforderlich:
- Fügen Sie in der Antwort des GET- Benutzers/ der GET-ID die resourceID der Abteilung "My Uploads" hinzu.JSON API- Aufruf.
- Öffnen Sie die POST assets.JSON API-Aufrufe für Admins, um ein Asset an die ID der persönlichen Abteilung senden zu können (über den LINK-Header).
- Wenn das Asset bereits vorhanden ist (überprüfen Sie den Dateinamen und die Erweiterung in derselben Abteilung), wird ein HTTP-Fehler 409 (Konflikt) zurückgegeben. Andernfalls wird ein HTTP-Fehler 201 zurückgegeben (erfolgreiche Erstellung).
- Admins können nur zur persönlichen Abteilung POSTEN. Sie können nicht GET, PUT, DELETE usw. durchführen
- Benutzer können eine POST-Anforderung zum Hochladen in „Meine Dateien“ verwenden, indem sie Folgendes verwenden:
/divisions/mine/assets.json?postProcessingInstructions={"materialisedPath":"/"}
1. Sich authentifizieren lassen
POST https: // {SUBDOMAIN}.Showpad.biz / API / v3 / oauth2 / token
HTTP-Basisauthentifizierung: Base64-Codierung ({API_CLIENT_ID} :{{API_CLIENT_SECRET}})
Abfrageparameter:
- Benutzername = {USERNAME}
- Passwort = {PASSWORD}
- grant_type = Passwort
Antwortbeispiel:
{
"access_token": "c3c7793691bea8e5e4c446260044fa853caec13d-VTJodmQzQmhaRTF2WW1sc1pVTnNhV1Z1ZEE9PS1NakEwTlRJPS1NUT09",
"expires_in": 3600,
"token_type": "Inhaber",
"scope": "refresh_token read_user_management write_user_management read_contentprofile_management write_contentprofile_management read_division_management write_division_management",
"refresh_token": "388158e65cb215c4757c89c3de1ae95a34609856-VTJodmQzQmhaRTF2WW1sc1pVTnNhV1Z1ZEE9PS1NakEwTlRJPS1NUT09"
}
2. Suchen Sie den Benutzer und die Benutzerdetails
GET https://{SUBDOMAIN}.showpad.biz/api/v3/users.json
Headers: Authorization: Bearer {OAUTH2_TOKEN}
Query Parameters:
- email={USER_EMAILADDRESS}
Response example:
{
"meta":{
"code":200,
"message":"OK",
"serverTime":"2017-09-27T11:49:20+00:00",
"lastUpdatedTime":"2017-09-27T11:49:20+00:00",
"requestRateLimit":5000,
"requestRateLimitReset":86400,
"requestsRemaining":4915
},
"response":{
"count":1,
"items":[{
"id": "322c5a6f89b45933243f3f6281e7f3c2",
"resourcetype": "Benutzer",
"href": "https: \ / \ / mycompany.showpad-dev.biz \ / API \ / v3 \ / users \ /322c5a6f89b45933243f3f6281e7f3c2",
"userName": "promoted.user@showpad.com"
}]
}
}
3. Suchen Sie den Benutzer myUploadsDivisionId
GET https: // {SUBDOMAIN}.Showpad.biz / API / v3 / users / {USER_ID}.JSON
Kopfzeilen: Autorisierung: Inhaber {OAUTH2_TOKEN}
Abfrageparameter:
- fields = myUploadsDivisionId
{
"meta":{
"code": 200,
"message": "OK",
"serverTime": "2017-10-02T09:43:06+00:00",
"lastUpdatedTime": "2017-10-02T09:43:06+00:00",
"requestRateLimit":5000,
„requestRateLimitReset“:86400,
„Anfragen Verbleibend“:5000
},
„response“:{
„myUploadsDivisionId“: „4d3716141c8ffb76928e602548fb9f1c“
}
}
4. Laden Sie das Asset hoch und verknüpfen Sie es richtig
POST https: // {SUBDOMAIN}.Showpad.biz / API / v3 / divisions / {myUploadsDivisionId /} assets.JSON? PostProcessingInstructions = {materializedPath: “/”}
Kopfzeilen: Autorisierung: Inhaber {OAUTH2_TOKEN}
Inhaltstyp: mehrteilig / Formulardaten
Körper (Beispiel)
--FMhuARzKvs8yEDDv
Inhaltsdisposition: Formulardaten; name = „file“; filename = „testfile2.txt“
Inhaltstyp: Text / Plain
fjezjeizfj
--FMhuARzKvs8yEDDv--
{
„Meta“:{
"code": 201,
"message": "Created",
"serverTime": "2017-09-27T11:49:36+00:00",
"lastUpdatedTime": "2017-09-27T11:49:36+00:00",
"requestRateLimit":5000, 5000
"requestRateLimitReset":86400, 86400
"RequestsRemaining":4915, 4915
"location": "https: \ / \ / mycompany.showpad-dev.biz \ / API \ / v3 \ / assets \ /5b65a2743446caa88f62f44b4aad3cc9"},
"response":{
"id": "5b65a2743446caa88f62f44b4aad3cc9",
"resourcetype": "Asset",
"href": "https: \ / \ / mycompany.showpad-dev.biz \ / API \ / v3 \ / assets \ /5b65a2743446caa88f62f44b4aad3cc9",
"name": "testfile2.txt",
"originalName": "testfile2.txt",
"description": null,
"filetype":"document",
"downloadLink":"https:\/\/mycompany.showpad-dev.biz\/api\/v3\/assets\/5b65a2743446caa88f62f44b4aad3cc9\/file\/v1",
"shortLivedDownloadLink":"https:\/\/mycompany.showpad-dev.biz\/share\/1506512976000301\/d7d7f51e598d670c0a21f79291a99d3e61caaef1",
"shortLivedDownloadDuration": 30,
"previewDownloadLink":"https:\/\/mycompany.showpad-dev.biz\/api\/v3\/assets\/5b65a2743446caa88f62f44b4aad3cc9\/preview\/v1.0",
"thumbnailDownloadLink": "https: \ / \ / mycompany.showpad-dev.biz \ / API \ / v3 \ / assets \ /5b65a2743446caa88f62f44b4aad3cc9\ / thumbnail \ /v1.0",
"isSensitive": false,
"isAnnotatable": false,
"isShareable": true,
"isDownloadable": true,
"isDivisionShared": false,
"useOptimized": true,
"Dateigröße": 10,
"Ansichten": 0,
"externalId": null,
"externalServiceId": null,
"externalDate": null,
"expiresAt": null,
"releasedAt": null,
"createdAt": "2017-09-27T11:49:35+00:00",
"updatedAt": 2017-09-27T11:49:36+00:00",
"archivedAt": null,
"beliebt": falsch,
"likesCount": 0,
"appLink": "Showpad: \ / \ / file \ /32271a3059052a9a5d3310ecfce56d45",
"standardId": "25",
"extension": "txt",
"lockedPages": null,
"pageCount": null,
"isPersonal": wahr,
"channelTemplateConfigId": null,
"onlyShareEntireDocument": false,
Schilder
"href": "https: \ / \ / mycompany.showpad-dev.biz \ / API \ / v3 \ / assets \ /5b65a2743446caa88f62f44b4aad3cc9\ / tags"
},
Aufteilung
"id": "4d3716141c8ffb76928e602548fb9f1c",
"href": "https: \ / \ / mycompany.showpad-dev.biz \ / API \ / v3 \ / divisions \ /4d3716141c8ffb76928e602548fb9f1c"
},
"assetView": {
"id": "4d4d5b064b589d4ef7c3446f63dcc8a7",
"href":"https:\/\/mycompany.showpad-dev.biz\/api\/v3\/assetviews\/4d4d5b064b589d4ef7c3446f63dcc8a7"
},
"uploadedAt": "2017-09-27T11:49:35+00:00"
}
}
Hinweis: Wenn Sie ein zu verarbeitendes Asset hochladen (z. B. PDF, Word, Excel, Powerpoint usw.), erhalten Sie als Antwort eine Ticket-ID. Fordern Sie diese Ticketressource solange (alle 30 Sekunden) an, bis Sie eine gültige Asset-ID erhalten. Weitere Informationen zur Verarbeitung der Dateien finden Sie hier.
Assets und Tags optimal erstellen
Hinweis: Im folgenden Szenario werden Unterteilungen nicht unterstützt.
Der schnelle Überblick
- Holen Sie sich alle verfügbaren Tags aus Showpad
- Fügen Sie bei Bedarf zusätzliche Tags hinzu
- Laden Sie alle Assets mit den erforderlichen Tags hoch
- Überprüfen Sie den Bearbeitungsstatus
Die detaillierte Übersicht
- Holen Sie sich alle verfügbaren Tags aus Showpad.
Holen Sie sich alle verfügbaren Tags aus Showpad und speichern Sie sie in einer Bibliothek oder Datenbank. Dies kann eine physische Datenbank oder nur eine Variable im Speicher sein.
Es ist wichtig, dass Sie einfach nach einem Tag anhand seines Namens suchen und dafür die entsprechende Showpad-ID erhalten können.
curl -X GET --header 'Accept: application/JSON' --header 'Authorization: Inhaber xxxxxxxxxxxxxxxxxx 'https://subdomain.showpad.biz/api/v3/tags.json?fields=id% 2C% 20name% 2C% 20externalService & limit = unlimited 'Parametererklärung:
felder = id, name, externalService
Dies gibt nur die Tag-ID, den Tag-Namen und den mit diesem Tag verknüpften externalService zurück.
Wenn Sie ein Tag über SharePoint erstellen, werden Sie feststellen, dass der Wert für externalService nicht null ist.
limit = unbegrenzt
Dies gibt bis zu 1000 Datensätze zurück. Behalten Sie die Anzahl der Datensätze in der Antwort im Auge. Wenn es mehr als 1000 ist, fügen Sie bitte auch einen Offset für die nächste Anforderung hinzu.
- Fügen Sie bei Bedarf zusätzliche Tags hinzu
curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' --header 'Authorization: Bearer xxxxxxxxxx' -d 'name=API%20tag' 'https://subdomain.showpad.biz/api/v3/tags.json'Dadurch wird die Showpad-ID für das erstellte Tag zurückgegeben
- Laden Sie alle Assets mit den erforderlichen Tags hoch
Dies ist der große API-Call-Saver.
curl
X POST --header 'Content-Type: multipart/form-data' --header 'Accept: application/json'-header 'Link: <36613327fa3b3d724211bdbb7c3e6a81; rel = Tag >, <36613327fafb3d724211bdbb7c3e6c91; rel = Tag >' --header 'Berechtigung: Inhaber xxxxxxxxxxxx' 'https://subdomain.showpad.biz/api/v3/assets.json'Hinweis: Der eigentliche Datei-Upload ist in der obigen Anfrage nicht enthalten.
Param Erklärung:
--header Link: Dies ist eine durch Kommas getrennte Liste aller - in diesem Fall - Tags, die mit dem Asset verknüpft werden sollen. Die Struktur eines Link-Elements lautet < showpadId; rel = ResourceType >
- Überprüfen Sie den Bearbeitungsstatus
curl -X GET --header 'Akzeptieren: application / JSON' --header 'Autorisierung: Inhaber xxxxxxxxxx https://subdomain.showpad.biz/api/v3/tickets.json?limit=unlimited&sort=-scheduledAt'Param Erklärung:
limit = unlimited: Dies gibt bis zu 1000 Datensätze zurück.
sort = -scheduledAt: Hiermit werden die Datensätze nach dem Zeitpunkt ihrer Erstellung (geplant) in absteigender Reihenfolge (neueste zuerst) sortiert.
Auf diese Weise können Sie leichter überprüfen, welche Assets verarbeitet wurden (oder nicht).
