Artikel

Fünf Schritte zum Einstieg mit der Smartsheet-API

by Taylor Krusen

Innovative IT-Teams, die die Smartsheet-API nutzen, profitieren schon mit Inbetriebnahme der Integration von den Vorteilen. Die API ist ein leistungsstarkes Tool für Entwickler, das eine Kombination aus sicherem Datenmanagement, Automatisierungen durch Webhooks und die Möglichkeit zur Skalierung von Smartsheet im gesamten Unternehmen gewährleistet.  

Sie möchten mithilfe der Smartsheet-API eine Integration erstellen, wissen aber nicht, wo Sie anfangen sollen? Befolgen Sie diese fünf Schritte, die wir im Folgenden detailliert beschrieben haben:

1. Entwicklerressourcen erkunden

Das Smartsheet Developer Portal ist der „Stützpunkt“ für alle Entwicklerressourcen. Dort finden Sie die API-Dokumentation, Informationen zu Smartsheet-SDKs, Antworten unserer Benutzer-Community auf Ihre spezifischen API-Fragen und vieles mehr.

So verlockend es auch sein mag, direkt mit der Erstellung Ihrer Integration zu beginnen, so wird es sich später umso mehr auszahlen, wenn Sie sich im Voraus die Zeit nehmen und einen Blick auf diese Ressourcen werfen. 

Hier finden Sie die API-Dokumentation

Nachdem Sie das Video gesehen haben, besuchen Sie unsere API-Dokumentationsseite. Ganz gleich, ob Sie eine Integration erstellen möchten, die die Smartsheet-API direkt aufruft, oder eine, die ein Smartsheet-SDK verwendet, die API-Dokumente enthalten viele nützliche Informationen. Machen Sie sich zunächst mit den folgenden Abschnitten vertraut:

  • Übersicht: Ein allgemeiner Kontext für die Arbeit mit der Smartsheet-API

  • Erste Schritte: Informationen, die Sie benötigen, um den Grundstein für Ihre Integration zu legen

  • Fehlerbehebung: Erstellen Sie einen Plan, um Probleme zu beheben, wenn Sie nicht weiterkommen

Smartsheet SDKs

Smartsheet Software Development Kits (SDKs) bieten eine Möglichkeit, mit der Programmiersprache Ihrer Wahl auf die Smartsheet-API zuzugreifen, ohne den gesamten Code von Grund auf neu schreiben zu müssen. Zusätzlich zu den vordefinierten Methoden enthält jedes SDK auch Wiederholungslogik (für Ratenbegrenzungsfehler) und Protokollierungssysteme.

Für jedes SDK (C#, Java, Node, Python, Ruby) stehen eine Dokumentation und ein Beispiel-Sheet mit Angaben zu Lese-/Schreibvorgängen als Referenz zur Verfügung.

2. „Entwicklerregistrierung“ abschließen 

Nachdem Sie sich einige Zeit mit unseren Smartsheet-Entwicklerressourcen befasst haben, sollten Sie bereit sein, den Grundstein für die Erstellung Ihrer Integration zu legen.

Entwicklerkonto erstellen

Wenn Sie planen, eine Drittanbieter-Anwendung zu erstellen, oder ein Sandbox-Smartsheet-Konto erstellen möchten, das Sie für Entwicklungs- und Testzwecke verwenden können (ohne die Daten in Ihrem Smartsheet-Produktionskonto zu beeinträchtigen), müssen Sie die Entwicklerregistrierung abschließen.

3. Zugriffstoken erstellen

Bildschirmaufnahme für den Zugriff auf Smartsheet

Um als Nächstes API-Anforderungen über den direkten API-Zugriff zu authentifizieren, benötigen Sie ein API-Zugriffstoken, das dem Smartsheet-Konto gehört, auf das Sie zugreifen möchten. Zugriffstoken können über die Smartsheet-Benutzeroberfläche generiert werden: Melden Sie sich einfach bei Ihrem Smartsheet-Konto an und folgen Sie dann diesen Anweisungen, um ein Token zu erstellen.

Wenn Sie eine Drittanbieter-Anwendung erstellen, die den OAuth2-Ablauf implementiert, um ein Zugriffstoken abzurufen, das für den Zugriff auf Smartsheet-Daten im Namen eines Endbenutzers verwendet werden kann, müssen Sie ein Zugriffstoken nicht wie oben beschrieben manuell generieren. Konsultieren Sie stattdessen die API-Dokumente, um Informationen zur Entwicklung einer Drittanbieter-Anwendung zu erhalten.

Wenn Sie eine Drittanbieter-Anwendung erstellen, die für andere Benutzer gedacht ist, müssen Sie einen OAuth2-Ablauf implementieren, um ein Zugriffstoken abzurufen. Die automatische (statt manuelle) Erstellung eines Zugriffstokens stellt sicher, dass der Benutzer über ein eigenes Token verfügt, um auf seine Smartsheet-Daten zuzugreifen. Wir empfehlen, den Abschnitt zur Entwicklung von Drittanbieter-Apps in der API-Dokumentation zu konsultieren. Zu Referenzzwecken bieten wir ein Tutorial zum Erstellen eines Smartsheet OAuth-Ablaufs in Node.js.

4. Mit der Erstellung Ihrer Integration beginnen

Der Prozess der Erstellung Ihrer Integration variiert je nach dem, ob Sie sich für die Verwendung eines SDK entscheiden oder nicht. Beide Ansätze werden im Folgenden detailliert beschrieben:

Mit SDK

Um ein SDK als Grundlage für Ihre Integration zu verwenden, installieren Sie das SDK Ihrer Wahl entsprechend den Anweisungen für das jeweilige SDK. Nutzen Sie dann die API-Dokumentation für Codebeispiele und führen Sie die folgenden Schritte aus:

  1. Wählen Sie im Codebeispielbereich auf der rechten Seite den Tab für die gewünschte Sprache aus.

  2. Lesen Sie die Readme-Datei und das Lese-/Schreibbeispiel für Ihre jeweiligen SDKs. Die Links finden Sie im Smartsheet Developer Portal.

  3. Navigieren Sie zu einem beliebigen Abschnitt der API-Referenz, um ein Codebeispiel anzuzeigen, das veranschaulicht, wie der Vorgang mit dem SDK ausgeführt wird.

Ohne SDK

Sie können zwar von der Verwendung eines SDK profitieren, aber es ist keineswegs obligatorisch. Wenn Sie auf die Verwendung eines SDK verzichten und stattdessen eine benutzerdefinierte Integration von Grund auf erstellen möchten, nutzen Sie als primäre Ressource die API-Dokumentation. Wenn Sie nicht weiterkommen, zögern Sie nicht, Ihre Fragen auf StackOverflow unter dem Tag smartsheet-api zu stellen. Ihre Frage könnte in Zukunft anderen helfen.

5. Smartsheet um Unterstützung bitten

Möglicherweise stoßen Sie auf ein API- oder SDK-Problem, das Sie nicht mithilfe unserer Anleitung zur API-Fehlerbehebung lösen können, oder Sie haben eine Frage, die in der API-Dokumentation nicht beantwortet wird. Erstellen Sie in StackOverflow einen Beitrag zu Ihrem Problem oder Ihrer Frage. Dort können wir Ihnen (gemeinsam mit Tausenden von Entwicklern weltweit) helfen.

Haben Sie Feedback zur API oder möchten Sie neue API-Funktionen vorschlagen? Setzen Sie sich unter DevRel@smartsheet.com mit uns in Verbindung.

Weitere Ressourcen entdecken

Wenn man eine neue API zum ersten Mal verwendet, gibt es eine Lernkurve, aber die richtigen Ressourcen und Prozesse können den Unterschied ausmachen.

Wir empfehlen Ihnen, die Ressourcen und Hinweise im Smartsheet Developer Portal bestmöglich zu nutzen. Diese sollen Sie dabei unterstützen, sich schneller mit der Verwendung der Smartsheet-API vertraut zu machen und selbstsicher eine eigene Lösung bereitzustellen.  

Abonnieren Sie den Smartsheet-IT-Newsletter, um Tipps, Strategien und Ideen zu erhalten, die IT-Spezialisten dabei unterstützen sollen, mehr in ihren Unternehmen zu erreichen.