Beispiele

  • Updated
Was ist für Sie drin?

Um zu sehen, was Sie mit der API von Showpad tun können, haben wir einige Beispiele bereitgestellt, die Sie inspirieren und Ihnen bei der Erstellung Ihrer Kreation helfen können.

Hinweis: Verwenden Sie auf der Online Platform von Showpad API Explorer, um eine Liste aller verfügbaren Parameter anzuzeigen. Sie finden sie auf der Registerkarte API der Administrator-Einstellungen.

Sie benötigen dies, um erfolgreich zu sein

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

Anleitungen zum Anfang

Erstellen einer PDF-Datei mit einem Tag

  1. Erstellen Sie ein Asset über die API via post/assets.JSON und rufen Sie die Antwort-ID ab.
  2. Kopieren Sie diese Antwort-ID und gehen Sie zu Tickets.
  3. Wählen Sie: GET/tickets/id.JSON und geben Sie die generierte ID ein
  4. Sie erhalten eine Antwort mit der ID des Assets:
    ,,asset": {,,id": "xxxxx",
  5. Erstellen Sie ein Tag über POST /tags.JSON oder suchen Sie die Tag-ID über Get/TAGS.JSON.
  6. Kopieren Sie diese Tag-ID.
  7. Gehen Sie zu Tags LINK / tags/id.JSON.
  8. Als ID-Wert geben Sie die ID des Tags an.
  9. Als Link-Wert geben Sie ,< add asset ID>; rel="Asset"' ein
Zurück zum Menü

Abrufen von Nutzerinformationen

Nachstehend finden Sie ein Beispiel für 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,
    ,,verbleibende Anfragen": 4975
  },
  ,,response": {
    ,,id": "12345",
    "Ressourcentyp": "nutzer",
    ,,Vorname": ,,Nettie",
    ,,Nachname": ,,Pierce",
    ,,E-Mail": ,,nettie@mycompany.com",
    ,,Benutzername": ,,nettie@mycompany.com",
    ,,Sprache": ,,en_US",
    ,,Nutzertyp": ,,Inhaber",
    ,,apiKey": "someApiKeyWithNumbersAndLetters",
    ,,externalId": null,
    ,,lastLogin": ,,2017-09-30 10:58:38",
    ,,lastConfirmedContentUpdate": null,
    ,,isActive": wahr,
    ,,Erstellt um": ,,2017-09-29 13:03:31",
    ,,Aktualisiert um": ,,2017-09-30 10:58:38",
    ,,nutzergruppen":{
      ,,href": ,,https://my-subdomain.showpad.biz/api/v2/users/12345/usergroups"
    },
    ,,Tableterlaubnis": null
  }

Die Antwort besteht aus zwei verschiedenen Teilen:

  • Meta: enthält den Antwortcode, die Nachricht und die Uhrzeit des Servers
  • Antwort: enthält die eigentliche Ressource einschließlich ihrer ID, ihres Typs, ihrer Attribute und Beziehungen
Zurück zum Menü

Rückgabe einer Vielzahl von Benutzern

Die Showpad-API nutzt auch das Konzept der Ressourcenlinks. Wenn eine Sammlung von Ressourcen angefordert wird (z. B. über GET /users.JSON), wird eine Vielzahl von Nutzern zurückgegeben, wie im folgenden Beispiel gezeigt:

{
  „meta“: {
    „code“: 200,
    „nachricht“: „OK“,
    ,,serverZeit": ,,2017-09-30 11:01:08",
    ,,letzteAktualiserteZeit": ,,2017-09-30 11:01:08",
    ,,requestRateLimit": 5000,
    ,,requestRateLimitReset": 86400,
    ,,verbleibende Anfragen": 4975
  },
  ,,antwort": {
    ,,anzahl": 2,
    ,,artikel":{
      {
        ,,id": ,,12345",
        ,,Ressourcentyp": ,,Nutzer",
        ,,href": ,,https://my-subdomain.showpad.biz/api/v2/users/12345
        Benutzername: nettie@mycompany.com
      },
      {
        ,,id": ,,123456",
        ,,Ressourcentyp": ,,Nutzer",
        ,,href": ,,https://my-subdomain.showpad.biz/api/v2/users/123456",
        Benutzername: elsabeth@mycompany.com
      }
    ]
  }
}

 Die Antwort besteht aus 2 verschiedenen Teilen:

  • meta: enthält den Antwortcode, die Nachricht und die Zeit des Servers
  • antwort: enthält die Gesamtzahl in dieser Sammlung und eine Vielzahl von Ressourcenlinks. Jeder Ressourcenlink enthält eine ID, einen Ressourcentyp, den Standort der Ressource und einige optionale Attribute. Beachten Sie, dass die Anzahl in der Antwort die Gesamtzahl der Ergebnisse ist, nicht die Anzahl auf der Seite. Wenn es zum Beispiel 50 Benutzer gibt und das Limit dieser Seite 25 ist, wird die Anzahl 50 und nicht 25 sein.
Zurück zum Menü

Verschieben von Inhalten in den persönlichen Ordner Meine Dateien eines Nutzers

Sie können die Showpad-API verwenden, um Inhalte in den Ordner ,,Meine Dateien" von Benutzern zu verschieben. Dazu sind die folgenden Komponenten erforderlich:

  • Fügen Sie die resourceID der Abteilung ,,Meine Dateien" in die Antwort auf den API-Aufruf GET nutzer/id.JSON ein.
  • Öffnen Sie den API-Aufruf POST assets.JSON für Administratoren, damit diese ein Asset in die persönliche Abteilungskennung einstellen können (über die LINK-Kopfzeile).
  • Wenn das Asset bereits existiert (Überprüfung von Dateiname und Erweiterung, in der gleichen Abteilung), wird ein 409 HTTP-Fehler (Konflikt) zurückgegeben. Andernfalls wird ein 201 HTTP-Fehler zurückgegeben (erfolgreiche Erstellung).
  • Admininistartoren können nur in den persönlichen Bereich POSTEN Sie sind nicht in der Lage, GET, PUT, DELETE, etc. auszuführen.
  • Nutzer können eine POST-Anfrage zum Hochladen in Meine Dateien verwenden:
/divisions/mine/assets.JSON?postProcessingInstructions={"materialisedPath":"/"}&isPersonal=true
1. Authentifiziert werden 
POST https://{SUBDOMAIN}.showpad.biz/api/v3/oauth2/token

HTTP-Basisauthentifizierung: base64 encode({API_CLIENT_ID}:{{API_CLIENT_SECRET}})

Abfrageparameter:

  • Benutzername={USERNAME}
  • Passwort={PASSWORT}
  • grant_type=password

Beispiel für eine Antwort:

{
    ,,access_token": "c3c7793691bea8e5e4c446260044fa853caec13d-VTJodmQzQmhaRTF2WW1sc1pVTnNhV1Z1ZEE9PS1NakEwTlRJPS1NUT09",
    ,,verfällt_in": 3600,
    ,,token_typ": ,,Überbringer",
    ,,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. Finden Sie die Nutzer und Nutzerinformationen 
GET https://{SUBDOMAIN}.showpad.biz/api/v3/users.json

Header: Autorisierung: Bearer {OAUTH2_TOKEN}

Abfrageparameter:

  • email={BENUTZER_EMAILADRESSE}

Beispiel für eine Antwort:

{
    ,,meta":{
        „code“: 200,
        „nachricht“: „OK“,
        ,,serverZeit":"2017-09-27T11:49:20+00:00",
        ,,letzteAktualisierte Zeit":"2017-09-27T11:49:20+00:00",
        ,,requestRateLimit":5000,
        ,,requestRateLimitReset": 86400,
        ,,requestsRemaining":4915
    },
    ,,antwort":{
        ,,anzahl":1,
        ,,artikel":[{
            ,,id":"322c5a6f89b45933243f3f6281e7f3c2",
            ,,resourcetype":"User",
            ,,href": ,,https:\/\/mycompany.showpad-dev.biz\/API\/v3\/users\/322c5a6f89b45933243f3f6281e7f3c2",
            Benutzername: promoted.user@showpad.com
        }]
    }
}
3. Suchen Sie die myUploadsDivisionId des Nutzers 
GET https://{SUBDOMAIN}.showpad.biz/api/v3/users/{USER_ID}.JSON

Header: Autorisierung: Bearer {OAUTH2_TOKEN}

Abfrageparameter:

  • fields=myUploadsDivisionId
{
    ,,meta":{
        „code“: 200,
        „nachricht“: „OK“,
        ,,serverZeit":"2017-10-02T09:43:06+00:00",
        ,,letzteAktualisierteZeit":"2017-10-02T09:43:06+00:00",
        ,,requestRateLimit":5000,
        ,,requestRateLimitReset": 86400,
        ,,requests remaining": 5000
    },
    ,,antwort":{
       ,,myUploadsDivisionId":,,4d3716141c8ffb76928e602548fb9f1c"

    }
}
4. Laden Sie das Asset hoch und verknüpfen Sie es korrekt 
POST https://{SUBDOMAIN}.showpad.biz/api/v3/divisions/{myUploadsDivisionId/}assets.JSON?postProcessingInstructions={materializedPath: “/”}

Headers: Authorization: Bearer {OAUTH2_TOKEN}

Inhaltstyp: multipart/form-data

Text (Beispiel)

--FMhuARzKvs8yEDDv
Inhalt-Disposition: form-data; name=,,file"; filename=,,testfile2.txt"
Inhaltstyp: text/plain
isPersonal=true

fjezjeizfj
--FMhuARzKvs8yEDDv--

{
    ,,meta":{
        ,,code":201,
        ,,nachricht": ,,Erstellt",
        ,,serverZeit":"2017-09-27T11:49:36+00:00",
        ,,letzteAktualisierteZeit":,,2017-09-27T11:49:36+00:00",
        ,,requestRateLimit":5000,
        ,,requestRateLimitReset": 86400,
        ,,requestsRemaining":4915,
        ,,location": "https:\/\/mycompany.showpad-dev.biz\/API\/v3\/assets\/5b65a2743446caa88f62f44b4aad3cc9"},
    ,,antwort":{
        ,,id":,,5b65a2743446caa88f62f44b4aad3cc9",
        ,,Ressourcentyp": ,,Asset",
        ,,href": ,,https:\/\/mycompany.showpad-dev.biz\/API\/v3\/assets\/5b65a2743446caa88f62f44b4aad3cc9",
        Name: testfile2.txt
        ,,originalName":,,testfile2.txt",
        ,,beschreibung":null,
        ,,Dateityp": ,,Dokument",
        ,,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,
        ,,fileSize":10,
        ,,Ansichten":0,
        ,,externalId":null,
        ,,externalServiceId":null,
        ,,externesDatum":null,
        ,,expiresAt":null,
        ,,releasedAt":null,
        ,,createdAt":"2017-09-27T11:49:35+00:00",
        ,,updatedAt":,,2017-09-27T11:49:36+00:00",
        ,,archiviertam":null,
        ,,Gefällt mir":false,
        ,,likesCount":0,
        ,,appLink": ,,Showpad:\/\/file\/32271a3059052a9a5d3310ecfce56d45",
        ,,standardId":,,25",
        ,,Erweiterung": ,,txt",
        ,,lockedPages":null,
        ,,pageCount":null,
        ,,isPersonal":true,
        ,,channelTemplateConfigId":null,
        ,,onlyShareEntireDocument":false,
        ,,tags":{
            ,,href": ,,https:\/\/mycompany.showpad-dev.biz\/API\/v3\/assets\/5b65a2743446caa88f62f44b4aad3cc9\/tags"
        },
        ,,Abteilung":{
            ,,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 Asset hochladen, das bearbeitet werden muss (z. B. PDF, Word, Excel, Powerpoint usw.), erhalten Sie als Antwort eine Ticket-ID. Rufen Sie diese Ticket-Ressource so lange ab (alle 30 Sekunden), bis Sie eine gültige Asset-ID erhalten. Weitere Informationen zur Dateiverarbeitung finden Sie hier.

Zurück zum Menü

Optimale Erstellung von Assets und Tags

Hinweis: In dem folgenden Szenario gibt es keine Unterstützung für Abteilungen.

Der schnelle Überblick

  1. Alle verfügbaren Tags aus Showpad abrufen
  2. Zusätzliche Tags hinzufügen - wenn nötig
  3. Hochladen aller Assets mit den erforderlichen Tags
  4. Prüfen Sie den Bearbeitungsstatus

Die detaillierte Übersicht

  1. Ruft alle verfügbaren Tags in Showpad ab.
    Ruft alle verfügbaren Tags in Showpad ab und speichert sie in einer Bibliothek oder Datenbank. Dabei kann es sich um eine physische Datenbank oder um eine Variable im Speicher handeln.
    Es ist wichtig, dass Sie einfach nach einem Tag anhand seines Namens suchen können und die entsprechende Showpad-ID erhalten.
    curl -X GET --header ,Accept: application/JSON' --header ,Authorization:
      Bearer xxxxxxxxxxxxxxxxxx 'https://subdomain.showpad.biz/api/v3/tags.json?fields=id%2C%20name%2C%20externalService& limit=unlimited'
    Erklärung der Parameter:
    fields=id,name,externalService
    Dies gibt nur die Tag-ID, den Tag-Namen und den mit diesem Tag verknüpften externen Service zurück.
    Wenn ein Tag über SharePoint erstellt wird, werden Sie feststellen, dass der Wert für externalService nicht null ist.
    limit=unlimited
    Dies ergibt bis zu 1000 Datensätze. Behalten Sie die Anzahl der Datensätze in der Antwort im Auge. Wenn es sich um mehr als 1000 handelt, fügen Sie bei der nächsten Anfrage bitte auch einen Offset hinzu.

  2. Zusätzliche Tags hinzufügen - wenn nötig
    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 '
    Dies gibt die Showpad-ID für das erstellte Tag zurück

  3. Laden Sie alle Assets mit den erforderlichen Tags hoch
    Dies ist der große API Call-Saver.

    curlX POST --header 'Content-Type: multipart/form-data' --header 'Accept:
      application/JSON' -header 'Link: <36613327fa3b3d724211bdbb7c3e6a81;rel=Tag>,<36613327fafb3d724211bdbb7c3e6c91;rel=Tag>'
      --header 'Authorization: Bearer xxxxxxxxxxxx' 'https://subdomain.showpad.biz/api/v3/assets.json'

    Hinweis: Der eigentliche Datei-Upload ist in der obigen Anfrage nicht enthalten.

    Erklärung von Parametern:
    --header Link: Dies ist eine durch Kommata getrennte Liste aller - in diesem Fall - Tags, die mit dem Asset verknüpft werden sollen. Die Struktur eines Link-Elements ist <showpadId;rel=ResourceType>

  4. Prüfen Sie den Bearbeitungsstatus

    curl -X GET --header ,Accept: application/JSON' --header ,Authorization:
      Inhaber xxxxxxxxxx' ,https://subdomain.showpad.biz/api/v3/tickets.json?limit=unlimited&sort=-scheduledAt'
    Erklärung von Parametern:
    limit=unlimited: Dies gibt bis zu 1000 Datensätze zurück.
    sort=-scheduledAt: Diese Option sortiert die Datensätze nach dem Zeitpunkt ihrer Erstellung (geplant) in absteigender Reihenfolge (das Neueste zuerst).
    Dadurch wird es einfacher zu überprüfen, welche Assets bearbeitet wurden (oder nicht).

Verwandte Beiträge

Holen Sie sich die neuesten Apps und E-Mail-Integrationen

iOS App Store Google Play Store Microsoft Store