Integrera med dataprovider för servergruppsaktiviteter

  • Artikel

Azure Data Manager for Agriculture har stöd för anslutningsappar för att enkelt synkronisera slutanvändarnas data från en rad olika datakällor för servergruppsmaskiner. Konfigurationen innebär att konfigurera oAuth-flödet som en förutsättning för att integrera med alla servergruppsaktiviteters dataprovider, tillsammans med ett transparent medgivandesteg per konto som hanterar inledande och inkrementell datasynkronisering för att hålla ADMA-dataegendomen uppdaterad.

Kommentar

Steg 1 till 3 ingår i den första konfigurationen för en gång per provider. När du är integrerad kan du låta alla slutanvändarna använda det befintliga oAuth-arbetsflödet och anropa konfigurations-API:et (steg 4) per användare (PartyID) för att hämta åtkomsttoken.

Providerkonfiguration

Exempelflödet här använder Climate FieldView

Steg 1: Skapa app

Om ditt program inte redan är registrerat med Climate Fieldview går du till FieldView-portalen och skickar formuläret. När FieldView bearbetar din begäran skickar de din client_id och client_secret som du använder en gång per ADMA-instans för FieldView.

Steg 2: Providerkonfiguration

Använd API:et oAuthProvider för att skapa eller uppdatera oAuth-providern (t.ex. FIELDVIEW) med lämpliga autentiseringsuppgifter för den nyligen skapade appen.

API-dokumentation: oAuthProviders – Skapa eller uppdatera

Valfritt steg: När åtgärden är klar kan du köra oAuthProviders_Get för att kontrollera om programmet är registrerat. Nu kan alla parter som skapats i din Azure Data Manager for Agriculture-instans använda FieldView som leverantör för att hämta servergruppsaktiviteter.

Steg 3: Slutpunktskonfiguration

Användaromdirigeringsslutpunkt: Den här slutpunkten är den punkt där du vill att användarna ska omdirigeras till när oAuth-flödet har slutförts. Den här slutpunkten genereras av dig och tillhandahålls till ADMA som userRedirectLink i api:et oauth/tokens/:connect. Registrera slutpunkten för oAuth-återanrop med din app på Climate FieldView-portalen.

Konfiguration av slutanvändarkonto

Steg 4: Integrering av part (slutanvändare)

När en part (slutanvändare) landar på din webbsida där användaråtgärden förväntas (t.ex. Anslut till FieldView-knappen) gör du ett anrop till oauth/tokens/:connect API:et nedan för att få tillbaka oAuth-providerns (t.ex. Climate FieldView) inloggnings-URI för att starta slutanvändarens oAuth-flöde.

API-dokumentation: oAuthTokens – Hämta OAuth Anslut ion Link

När API:et oauth/tokens/:connect har returnerat klickar slutanvändaren oauthAuthorizationLinkpå den här länken för att slutföra oAuth-flödet (t.ex. för Climate FieldView får användaren ett FieldView-åtkomstmedgivande och inloggningssida). När inloggningen är klar omdirigerar ADMA användaren till slutpunkten som tillhandahålls av kunden (userRedirectLink) med följande frågeparametrar i URL:en

  1. status (lyckades/misslyckades)
  2. tillstånd (valfri sträng för att unikt identifiera användaren i kundens slut)
  3. meddelande (valfri sträng)
  4. errorCode (valfri sträng som skickas för fel/fel) i parametrarna.

Kommentar

Om API:et returnerar 404 innebär det att oAuth-flödet misslyckades och att ADMA inte kunde hämta åtkomsttoken.

Steg 5: Kontrollera information om åtkomsttoken (valfritt)

Det här steget är valfritt, bara för att bekräfta om den nödvändiga giltiga åtkomsttoken har hämtats eller inte för en viss användare eller lista över användare. Detta kan göras genom att göra ett anrop till API:et oauth/tokens för att söka efter posten isValid: true i svarstexten.

API-dokumentation: oAuthTokens – lista

Det här steget markerar att oAuth-flödet har slutförts för en användare. Nu är användaren helt inställd på att utlösa ett nytt FarmOperationsDataJob för att börja hämta servergruppsaktiviteter från Climate FieldView.