Integration mit Farmaktivitäten Datenanbieter

  • Artikel

Azure Data Manager für Landwirtschaft unterstützt Connectors, um die Daten Ihrer Endbenutzer bequem aus einer Reihe von Farmmaschinendatenquellen zu synchronisieren. Das Setup umfasst das Konfigurieren des oAuth-Flusses als Voraussetzung für die Integration mit jedem Farmaktivitäten-Datenanbieter sowie einen transparenten Zustimmungsschritt, der die anfängliche und inkrementelle Datensynchronisierung verarbeitet, um den ADMA-Datenbestand auf dem neuesten Stand zu halten.

Hinweis

Die Schritte 1 bis 3 sind Teil der einmaligen Erstkonfiguration pro Anbieter. Nach der Integration können Sie allen Endbenutzern die Verwendung des vorhandenen oAuth-Workflows ermöglichen und die Konfigurations-API (Schritt 4) pro Benutzer (PartyID) aufrufen, um das Zugriffstoken abzurufen.

Anbietereinrichtung

Der Beispielfluss hier verwendet Climate FieldView

Schritt 1: App-Erstellung

Wenn Ihre Bewerbung noch nicht bei Climate Fieldview registriert ist, wechseln Sie zum FieldView-Portal , und übermitteln Sie das Formular. Sobald FieldView Ihre Anforderung verarbeitet hat, senden sie Ihre client_id Und client_secret die Sie pro ADMA-Instanz für FieldView einmal verwenden.

Schritt 2: Anbieterkonfiguration

Verwenden Sie die oAuthProvider API, um den oAuth-Anbieter (z. B. FIELDVIEW) mit den entsprechenden Anmeldeinformationen der neu erstellten App zu erstellen oder zu aktualisieren.

API-Dokumentation: oAuthProviders – Erstellen oder Aktualisieren

Optionaler Schritt: Nachdem der Vorgang abgeschlossen ist, können Sie die oAuthProviders_Get ausführen, um zu überprüfen, ob die Anwendung registriert ist. Jetzt können alle parteien, die in Ihrer Azure Data Manager for Agriculture-Instanz erstellt wurden, FieldView als Anbieter verwenden, um Farmaktivitätendaten abzurufen.

Schritt 3: Endpunktkonfiguration

Benutzerumleitungsendpunkt: Dieser Endpunkt ist der Ort, an dem Ihre Benutzer nach Abschluss des oAuth-Flusses umgeleitet werden sollen. Dieser Endpunkt wird von Ihnen generiert und adMA wie userRedirectLink in der oauth/tokens/:connect-API bereitgestellt. Registrieren Sie den oAuth-Rückrufendpunkt bei Ihrer App im Climate FieldView-Portal.

Einrichtung des Endbenutzerkontos

Schritt 4: Partyintegration (Endbenutzer)

Wenn eine Partei (Endbenutzer) auf Ihrer Webseite landet, auf der die Benutzeraktion erwartet wird (z. B. Verbinden zur FieldView-Schaltfläche), rufen Sie oauth/tokens/:connect die API in der folgenden Weise auf, um den Anmelde-URI des oAuth-Anbieters (Ex: Climate FieldView) abzurufen, um den OAuth-Ablauf des Endbenutzers zu starten.

API-Dokumentation: oAuthTokens – OAuth Verbinden ion Link abrufen

Nachdem die oauth/tokens/:connect API erfolgreich die oauthAuthorizationLinkAPI zurückgegeben hat, klickt der Endbenutzer auf diesen Link, um den oAuth-Fluss abzuschließen (z. B.: Für Climate FieldView wird dem Benutzer eine FieldView-Zugriffszustimmung und -anmeldeseite bereitgestellt). Sobald die Anmeldung abgeschlossen ist, leitet ADMA den Benutzer an den vom KundenuserRedirectLink () bereitgestellten Endpunkt mit den folgenden Abfrageparametern in der URL um.

  1. Status (Erfolg/Fehler)
  2. Status (optionale Zeichenfolge, um den Benutzer am Kundenende eindeutig zu identifizieren)
  3. Message (optionale Zeichenfolge)
  4. errorCode (optionale Zeichenfolge, die für Fehler/Fehler gesendet wird) in den Parametern.

Hinweis

Wenn die API 404 zurückgibt, bedeutet dies, dass der oAuth-Fluss fehlgeschlagen ist und ADMA das Zugriffstoken nicht abrufen konnte.

Schritt 5: Überprüfen von Zugriffstokeninformationen (optional)

Dieser Schritt ist optional, nur um zu bestätigen, ob für einen bestimmten Benutzer oder eine bestimmte Liste von Benutzern das erforderliche gültige Zugriffstoken erworben wurde oder nicht. Dies kann über einen Aufruf der oauth/tokens API erfolgen, um den Eintrag isValid: true im Antworttext zu überprüfen.

API-Dokumentation: oAuthTokens – Liste

Dieser Schritt markiert den erfolgreichen Abschluss des oAuth-Flusses für einen Benutzer. Jetzt ist der Benutzer so eingestellt, dass ein neuer FarmOperationsDataJob ausgelöst wird, um mit dem Abrufen der Farmaktivitätendaten aus Climate FieldView zu beginnen.