Integração com o provedor de dados de atividades do farm
O Azure Data Manager for Agriculture oferece suporte a conectores para sincronizar convenientemente os dados dos usuários finais de uma variedade de fontes de dados de máquinas agrícolas. A configuração envolve a configuração do fluxo oAuth como um pré-requisito para a integração com qualquer provedor de dados de Atividades do Farm, juntamente com uma etapa de consentimento transparente por conta que lida com a sincronização de dados inicial e incremental para manter o conjunto de dados ADMA atualizado.
Observação
As etapas 1 a 3 fazem parte da configuração inicial única por provedor. Uma vez integrado, você poderá permitir que todos os usuários finais usem o fluxo de trabalho oAuth existente e chamem a API de configuração (Etapa 4) por usuário (PartyID) para recuperar o token de acesso.
Configuração do provedor
O fluxo de exemplo aqui usa Climate FieldView
Etapa 1: Criação de aplicativos
Se a sua candidatura ainda não estiver registada no Climate Fieldview, aceda ao portal FieldView e submeta o formulário. Depois que o FieldView processar sua solicitação, eles enviarão sua client_id
e client_secret
que você usará uma vez por instância do ADMA para FieldView.
Etapa 2: Configuração do provedor
Use a oAuthProvider
API para criar ou atualizar o provedor oAuth (por exemplo, FIELDVIEW) com as credenciais apropriadas do aplicativo recém-criado.
Documentação da API: oAuthProviders - Criar ou atualizar
Etapa opcional: Uma vez concluída a operação, você pode executar o oAuthProviders_Get para verificar se o aplicativo está registrado. Agora, todas as partes criadas em sua instância do Azure Data Manager for Agriculture podem usar FieldView como um provedor para buscar dados de Atividades do Farm.
Etapa 3: Configuração do ponto de extremidade
Ponto de extremidade de redirecionamento de usuário: esse ponto de extremidade é para onde você deseja que seus usuários sejam redirecionados assim que o fluxo oAuth for concluído. Esse endpoint será gerado por você e fornecido ao ADMA como userRedirectLink
na API oauth/tokens/:connect.
Registre o ponto de extremidade de retorno de chamada oAuth com seu aplicativo no portal Climate FieldView.
Configuração da conta de usuário final
Etapa 4: Integração de partes (usuário final)
Quando uma parte (usuário final) chegar à sua página da Web onde a ação do usuário é esperada (por exemplo, botão Conectar ao FieldView), faça uma chamada para a API da maneira abaixo para obter o uri de entrada do provedor oAuth (por exemplo, Climate FieldView) de volta para oauth/tokens/:connect
iniciar o fluxo oAuth do usuário final.
Documentação da API: oAuthTokens - Get OAuth Connection Link
Depois que a oauth/tokens/:connect
API retorna com êxito o , o usuário final clica neste link para concluir o fluxo oAuth (por exemplo, para Climate FieldView, o oauthAuthorizationLink
usuário recebe uma página de consentimento de acesso e login do FieldView). Depois que a entrada for concluída, o ADMA redirecionará o usuário para o ponto de extremidade fornecido pelo cliente (userRedirectLink
) com os seguintes parâmetros de consulta na url
- Status (Sucesso/Falha)
- state (cadeia de caracteres opcional para identificar exclusivamente o usuário no final do cliente)
- mensagem (cadeia de caracteres opcional)
- errorCode (cadeia de caracteres opcional enviada para Falha/erro) nos parâmetros.
Observação
Se a API retornar 404, isso implicará que o fluxo oAuth falhou e o ADMA não pôde adquirir o token de acesso.
Etapa 5: Verificar informações do token de acesso (opcional)
Esta etapa é opcional, apenas para confirmar se para um determinado usuário ou lista de usuários, o token de acesso válido necessário foi adquirido ou não. Isso pode ser feito fazendo uma chamada para a API para verificar a oauth/tokens
entrada isValid: true
no corpo da resposta.
Documentação da API: oAuthTokens - Lista
Esta etapa marca a conclusão bem-sucedida do fluxo oAuth para um usuário. Agora, o usuário está pronto para acionar um novo FarmOperationsDataJob para começar a extrair os dados de Atividades Agrícolas do Climate FieldView.