Anwendungen integrieren mit der offenen API von Reviso

Wenn Sie eine Integration mit Reviso programmieren wollen, müssen Sie einige Schritte folgen.

In diesem Artikel werden wir versuchen, diese Schritte zu erläutern, damit die Integration korrekt ausgeführt wird:

  • Als Entwickler anmelden (kostenlos)
  • Erstellen Sie die Beschreibung der zu integrierenden Anwendung
  • Anwendung aktivieren (Zugang generieren)
  • Verwenden Sie die “REST API”

Als Entwickler bei Reviso anmelden

Um sich zu registrieren, müssen Sie folgenden Link anfordern: https://www.reviso.com/developer und das Formular auf der rechten Seite korrekt ausfüllen. Damit werden ein Zugang und eine Vertragsnummer erstellt. Dieser Zugang wird erstellt, um die Integration durchführen zu können, und wird nur für 14 Tage gültig sein. Sie haben also 14 Tage Zeit, um ihn zu verwenden und die Anwendung zu integrieren.

In jedem Fall kann der Zugang verlängert werden, wenn er nicht ausreicht, indem Sie uns einfach eine E-Mail (auf englisch) an api@www.reviso.com senden.

Erstellen Sie die Definition Ihrer Anwendung (App)

Ihr Entwicklerzugang kann eine unbestimmte Anzahl von Definitionen für die App enthalten. Wenn Sie sich als Benutzer registrieren, wird automatisch einer erstellt. Wurde dieser jedoch versehentlich erstellt, können Sie einen neuen erstellen und den vorherigen löschen.

Um eine Definition der App zu erstellen, müssen Sie sich lediglich anmelden und sie erstellen, sobald Sie sich im System befinden. Die Definition einer Anwendung weist eine Reihe von Eigenschaften auf, mit denen Sie Ihre Anwendung mit Review verbinden können, und gibt an, wie Reviso sich auf Ihre Anwendung beziehen soll.

Name

Dies ist der Name der Anwendung, der den Reviso-Benutzern angezeigt wird, wenn sie die Anwendung aktivieren oder ggf. später deaktivieren möchten.

Öffentliches Token

Dies ist die eindeutige Kennung, mit der die App identifiziert werden kann, wenn Benutzer aufgefordert werden, die App zu aktivieren (dazu später mehr) und wenn sie sich an Reviso wenden (z. B. für Support).

Dies kann neu generiert werden, wenn Sie die App erneut freigeben möchten. Beachten Sie jedoch, dass alle Links zur Registrierung für die Nutzung der App dann nicht mehr funktionieren.

Privates Token

Dieses private Token sollte nicht an Dritte weitergegeben werden, da es für das Sicherheitsmodell von wesentlicher Bedeutung ist, es geheim zu halten.

Dies kann neu generiert werden (z. B. wenn das private Token der Öffentlichkeit zugänglich gemacht wurde). Beachten Sie jedoch, dass dies bedeutet, dass alle vorhandenen für die App generierten Zuschüsse nicht mehr funktionieren

Erforderliche Rollen

Die Liste der Rollen beschreibt die verschiedenen Daten, auf welche die App in Reviso zugreifen kann. Nicht alle Benutzer in Reviso können auf alle Daten zugreifen. Fügen Sie daher nur die Rollen hinzu, die für die Funktion Ihrer App erforderlich sind. Wenn Ihre App diese Bereiche nicht speziell berührt, sollten Sie beispielsweise die Rollen Inventar, Projektanalyse, Projektmitarbeiter und Berichte am besten auslassen.

Wenn ein Benutzer keinen Zugriff auf eine bestimmte Rolle hat (normalerweise durch ein Modul gekennzeichnet, das in Reviso abonniert werden kann), kann er die App nicht aktivieren. In ähnlicher Weise kann er die App aktivieren und ein erforderliches Modul wird entfernt dann kann die App nicht mehr auf diese Daten zugreifen.

Aktivieren Sie die Anwendung / App

In Reviso sind mindestens zwei Zugänge (Accounts) erforderlich, um Zugriff auf die API zu erhalten.

  • Entwicklerzugang, welcher die Definition der App (s) enthält
  • Zugang mit einem Unternehmen (Geschäftsvereinbarung), welches Buchhaltungsdaten enthält, wie Konten, Kunden usw.

Damit eine App auf die Daten einer bestimmten Geschäftsvereinbarung zugreifen kann, muss ein Grant (Zugriff) generiert werden. Ein Grant repräsentiert den Zugriff einer App auf die Daten einer bestimmten Geschäftsvereinbarung (im Namen eines bestimmten Benutzers in dieser Vereinbarung). Wenn er gelöscht wird, hat die App keinen Zugriff mehr auf die Daten (es sei denn, es existiert ein anderer Grant).

Um eine App zu aktivieren, muss der Benutzer in der Geschäftsvereinbarung zu https://app.reviso.com/api1/requestaccess.aspx?appPublicToken=publicToken navigieren, wobei das letzte publicToken-Bit das zuvor beschriebene öffentliche Token ist.

Dem Benutzer werden Informationen zur App und zu den Daten angezeigt, auf die er zugreifen muss. Wenn der Benutzer die App aktivieren möchte, muss er lediglich eine Bestätigung durch Eingabe von Vereinbarung, Benutzer-ID und Passwort vornehmen.

Die Seite gibt dann ein Grant-Token zurück, welches an die App weitergeleitet werden muss.

Holen Sie sich die Daten

Um Daten von der API abzurufen, benötigen Sie zwei Token:

  • Privates Token (wie oben beschrieben)
  • Grant Token (muss generiert werden)

Um zu erfahren, was integriert werden kann und wie es geht, besuchen Sie unseren spezifischen API-Leitfaden: http://api-docs.reviso.com