Integreren met farmactiviteitengegevensprovider
Azure Data Manager for Agriculture ondersteunt connectors om de gegevens van uw eindgebruikers gemakkelijk te synchroniseren vanuit verschillende gegevensbronnen voor farmmachines. De installatie omvat het configureren van de oAuth-stroom als een vereiste voor integratie met een farmactiviteitengegevensprovider, samen met een transparante toestemmingsstap per account waarmee de initiële en incrementele gegevenssynchronisatie wordt verwerkt om de ADMA-gegevensomgeving up-to-date te houden.
Notitie
Stap 1 tot en met 3 maakt deel uit van de eenmalige configuratie per provider. Zodra deze is geïntegreerd, kunt u al uw eindgebruikers in staat stellen de bestaande oAuth-werkstroom te gebruiken en de configuratie-API (stap 4) per gebruiker (PartyID) aan te roepen om het toegangstoken op te halen.
Provider instellen
De voorbeeldstroom hier maakt gebruik van Climate FieldView
Stap 1: App maken
Als uw toepassing nog niet is geregistreerd bij Climate Fieldview, gaat u naar de FieldView-portal en verzendt u het formulier. Zodra FieldView uw aanvraag verwerkt, verzenden ze uw client_id aanvraag en client_secret die u eenmaal per ADMA-exemplaar voor FieldView gaat gebruiken.
Stap 2: Providerconfiguratie
Gebruik de oAuthProvider API om de oAuth-provider (bijvoorbeeld FIELDVIEW) te maken of bij te werken met de juiste referenties van de zojuist gemaakte app.
API-documentatie: oAuthProviders - Maken of bijwerken
Optionele stap: Zodra de bewerking is voltooid, kunt u de oAuthProviders_Get uitvoeren om te controleren of de toepassing is geregistreerd. Nu kunnen alle partijen die zijn gemaakt in uw instantie van Azure Data Manager for Agriculture FieldView gebruiken als provider om farmactiviteitengegevens op te halen.
Stap 3: Eindpuntconfiguratie
Eindpunt voor gebruikersomleiding: dit eindpunt is waar u wilt dat uw gebruikers worden omgeleid zodra de oAuth-stroom is voltooid. Dit eindpunt wordt door u gegenereerd en aan ADMA verstrekt, zoals userRedirectLink in de oauth/tokens/:connect-API.
Registreer het oAuth-callback-eindpunt bij uw app in de Climate FieldView-portal.
Account voor eindgebruikers instellen
Stap 4: Integratie van partijen (eindgebruiker)
Wanneer een partij (eindgebruiker) op uw webpagina terechtkomt waar de actie van de gebruiker wordt verwacht (bijvoorbeeld: Verbinding maken naar de knop FieldView), roept u de API op de onderstaande manier aan oauth/tokens/:connect om de aanmeldings-URI van de oAuth-provider (Bijvoorbeeld: Climate FieldView) weer op te halen om de oAuth-stroom van de eindgebruiker te starten.
API-documentatie: oAuthTokens - OAuth Verbinding maken ion Link ophalen
Zodra de API de oauth/tokens/:connectoauthAuthorizationLinkkoppeling heeft geretourneerd, klikt de eindgebruiker op deze koppeling om de oAuth-stroom te voltooien (bijvoorbeeld: Voor Climate FieldView wordt de gebruiker een FieldView-toegangstoestemming en aanmeldingspagina aangeboden). Zodra de aanmelding is voltooid, leidt ADMA de gebruiker om naar het eindpunt van de klant (userRedirectLink) met de volgende queryparameters in de URL
- status (geslaagd/mislukt)
- status (optionele tekenreeks om de gebruiker aan het eind van de klant uniek te identificeren)
- bericht (optionele tekenreeks)
- errorCode (optionele tekenreeks verzonden voor fout/fout) in de parameters.
Notitie
Als de API 404 retourneert, betekent dit dat de oAuth-stroom is mislukt en ADMA het toegangstoken niet kan verkrijgen.
Stap 5: Toegangstokengegevens controleren (optioneel)
Deze stap is optioneel, alleen om te bevestigen of voor een bepaalde gebruiker of lijst met gebruikers het vereiste geldige toegangstoken is verkregen of niet. Dit kan worden gedaan via een aanroep naar de oauth/tokens API om te controleren op de vermelding isValid: true in de hoofdtekst van het antwoord.
API-documentatie: oAuthTokens - Lijst
Deze stap markeert de geslaagde voltooiing van de oAuth-stroom voor een gebruiker. De gebruiker is nu klaar om een nieuwe FarmOperationsDataJob te activeren om de farmactiviteitengegevens op te halen uit Climate FieldView.