Skip to content
GitLab

Home · Changes

Page history
Update Home authored by Enio de Jesus Pontes Monteiro's avatar Enio de Jesus Pontes Monteiro
Hide whitespace changes
Inline Side-by-side
Home.md
View page @ 10f56e05
# API Zarc NM # API Zarc NM (SINM)
<!-- Texto mais geral, explicando a API Zarc para níveis de manejo --> <!-- Texto mais geral, explicando a API Zarc para níveis de manejo -->
A API do Zarc-NM foi desenvolvida com o propósito de receber dados relacionados à glebas (ou talhões) produtivas e a partir dos dados recebidos, classificar a gleba de acordo com o seu nível de manejo, seguindo a metodologia de classificação publicada em 2022 pela Embrapa com o título [**"Níveis de manejo do solo para avaliação de riscos climáticos na cultura da soja."**](https://ainfo.cnptia.embrapa.br/digital/bitstream/doc/1148652/1/DOCUMENTO-447-final.pdf) (DEBIASI, H.; MONTEIRO, J. E. B. de A.; FRANCHINI, J. C.; FARIAS, J. R. B.; CONTE, O.; CUNHA, G. R. da; MORAES, M. T. de; BALBINOT JUNIOR, A. A.; SILVA, F. A. M. da; EVANGELISTA, B. A.; MARAFON, A. C.). O SINM foi desenvolvido com o propósito de receber dados relacionados à glebas (ou talhões) produtivas e a partir dos dados recebidos, classificar a gleba de acordo com o seu nível de manejo, seguindo a metodologia de classificação publicada em 2022 pela Embrapa com o título [**"Níveis de manejo do solo para avaliação de riscos climáticos na cultura da soja."**](https://ainfo.cnptia.embrapa.br/digital/bitstream/doc/1148652/1/DOCUMENTO-447-final.pdf) (DEBIASI, H.; MONTEIRO, J. E. B. de A.; FRANCHINI, J. C.; FARIAS, J. R. B.; CONTE, O.; CUNHA, G. R. da; MORAES, M. T. de; BALBINOT JUNIOR, A. A.; SILVA, F. A. M. da; EVANGELISTA, B. A.; MARAFON, A. C.).
## Requisitos ## Requisitos
...@@ -28,19 +28,19 @@ Principais atores interessados: ...@@ -28,19 +28,19 @@ Principais atores interessados:
## Arquitetura ## Arquitetura
<!-- Descrever e mostra através de diagramas a visão arquitetural do sistema em níveis macro e em detalhes (não tão detalhado) --> <!-- Descrever e mostra através de diagramas a visão arquitetural do sistema em níveis macro e em detalhes (não tão detalhado) -->
**Visão geral da API Zarc-NM:** **Visão geral do SINM:**
![overview-api-zarcnm](uploads/8db8a36fddbe950d4b46eac5d0f173aa/overview-api-zarcnm.png) ![overview-api-zarcnm](uploads/8db8a36fddbe950d4b46eac5d0f173aa/overview-api-zarcnm.png)
</br> </br>
**Visão Arquitetural da API ZARC-NM:** **Visão Arquitetural do SINM:**
![architecture-overview](uploads/dd81cb5a2de9d0e9e177b0861586468c/architecture-overview.png) ![architecture-overview](uploads/dd81cb5a2de9d0e9e177b0861586468c/architecture-overview.png)
## Funcionamento ## Funcionamento
Para a utilização da API ZarcNM, primeiramente é necessário autenticar-se com usuário com credencias válidas e assim obter um token de acesso. Em posse do token de acesso e dentro de seu período de validade, as APIs podem ser acessadas. Abaixo, vamos ilustrar como se dá a autenticação e posteriormente o uso das APIs. Depois, na seção "Como usar", temos um passo a passo com templates e imagens de uso das APIs por meio da ferramenta Postman. Para a utilização do SINM, primeiramente é necessário autenticar-se com usuário com credencias válidas e assim obter um token de acesso. Em posse do token de acesso e dentro de seu período de validade, as APIs podem ser acessadas. Abaixo, vamos ilustrar como se dá a autenticação e posteriormente o uso das APIs. Depois, na seção "Como usar", temos um passo a passo com templates e imagens de uso das APIs por meio da ferramenta Postman.
### 1. Autenticação ### 1. Autenticação
...@@ -52,7 +52,7 @@ Obtendo o token de acesso após validação das credencias ...@@ -52,7 +52,7 @@ Obtendo o token de acesso após validação das credencias
![Autenticacao-2.drawio](uploads/b5c866489c5d3ff113d03d0ff0f00ff2/Autenticacao-2.drawio.png) ![Autenticacao-2.drawio](uploads/b5c866489c5d3ff113d03d0ff0f00ff2/Autenticacao-2.drawio.png)
Enviando uma requisição a API do ZarcNM Enviando uma requisição ao SINM
![Autenticacao-3.drawio](uploads/15fabbfa3e8360622ad01f8e10d64442/Autenticacao-3.drawio.png) ![Autenticacao-3.drawio](uploads/15fabbfa3e8360622ad01f8e10d64442/Autenticacao-3.drawio.png)
...@@ -92,9 +92,9 @@ Resposta da requisição enviada pela aplicação cliente ...@@ -92,9 +92,9 @@ Resposta da requisição enviada pela aplicação cliente
### 1. Autenticação de usuário ### 1. Autenticação de usuário
Para ter acesso a [`API Zarc-NM`](#api-zarc-nm) o usuário precisa estar autenticado. A autenticação é realizada via protocolo [*OpenId Connect*](https://auth0.com/pt/intro-to-iam/what-is-openid-connect-oidc) (OIDC) usando o fluxo *Password Credentials* da especificação [*OAuth2*](https://auth0.com/pt/intro-to-iam/what-is-oauth-2). Para demonstrar como é realizado o processo de auntenticação e acesso aos *endpoints* da [`API Zarc-NM`](#api-zarc-nm) , iremos utilizar a plataforma [*Postman*](https://www.postman.com/). Para ter acesso ao SINM (#api-zarc-nm) o usuário precisa estar autenticado. A autenticação é realizada via protocolo [*OpenId Connect*](https://auth0.com/pt/intro-to-iam/what-is-openid-connect-oidc) (OIDC) usando o fluxo *Password Credentials* da especificação [*OAuth2*](https://auth0.com/pt/intro-to-iam/what-is-oauth-2). Para demonstrar como é realizado o processo de auntenticação e acesso aos *endpoints* da [`API Zarc-NM`](#api-zarc-nm) , iremos utilizar a plataforma [*Postman*](https://www.postman.com/).
Foi criado um arquivo [*JSON*](https://www.json.org/json-pt.html) nomeado ***Endpoints_API_Zarc-NM_-_SEM_CREDENCIAIS.postman_collection.json***, nesse arquivo há uma *collection* com os *enpoints* presentes na [`API Zarc-NM`](#api-zarc-nm). Para enviar requisições a [`API Zarc-NM`](#api-zarc-nm), primeiramente baixe o arquivo ***Endpoints_API_Zarc-NM_-_SEM_CREDENCIAIS.postman_collection.json*** que encontra-se disponível para *download* em: [uploads/eeb07531a519d37db195010995f487ef/Endpoints_API_Zarc-NM_-_SEM_CREDENCIAIS.postman_collection.json](uploads/eeb07531a519d37db195010995f487ef/Endpoints_API_Zarc-NM_-_SEM_CREDENCIAIS.postman_collection.json), em seguida, faça a importação do arquivo no [*Postman*](https://www.postman.com/). Para importar o arquivo no [*Postman*](https://www.postman.com/), acesse a aba ***File*** (*Cf*. retângulo vermelho, Figura 1), em seguida, clique na opção ***Import...*** (*Cf*. retângulo amarelo, Figura 1). Foi criado um arquivo [*JSON*](https://www.json.org/json-pt.html) nomeado ***Endpoints_API_Zarc-NM_-_SEM_CREDENCIAIS.postman_collection.json***, nesse arquivo há uma *collection* com os *enpoints* presentes na [`SINM`](#api-zarc-nm). Para enviar requisições ao [`SINM`](#api-zarc-nm), primeiramente baixe o arquivo ***Endpoints_API_Zarc-NM_-_SEM_CREDENCIAIS.postman_collection.json*** que encontra-se disponível para *download* em: [uploads/eeb07531a519d37db195010995f487ef/Endpoints_API_Zarc-NM_-_SEM_CREDENCIAIS.postman_collection.json](uploads/eeb07531a519d37db195010995f487ef/Endpoints_API_Zarc-NM_-_SEM_CREDENCIAIS.postman_collection.json), em seguida, faça a importação do arquivo no [*Postman*](https://www.postman.com/). Para importar o arquivo no [*Postman*](https://www.postman.com/), acesse a aba ***File*** (*Cf*. retângulo vermelho, Figura 1), em seguida, clique na opção ***Import...*** (*Cf*. retângulo amarelo, Figura 1).
<div align="center"> <div align="center">
...@@ -150,7 +150,7 @@ Logo após, clique no botão ***Proceed*** (*Cf*. retângulo amarelo, Figura 5) ...@@ -150,7 +150,7 @@ Logo após, clique no botão ***Proceed*** (*Cf*. retângulo amarelo, Figura 5)
</div> </div>
Por fim, clique no botão ***Use Token*** (*Cf*. retângulo amarelo, Figura 6). Depois de executar esses passos, o token recebido é habilitado possibiltando o usuário realizar requisições com acesso autenticado para a [`API Zarc-NM`](#api-zarc-nm). Esses passos devem serem realizados apenas na *collection* ***Endpoints API Zarcn-NM***, pois isso habilita o token em todos os endpoints presentes nessa *collection*. Adicionalmente, esse procedimento deve ser realizado todas as vezes que o token expirar. Por fim, clique no botão ***Use Token*** (*Cf*. retângulo amarelo, Figura 6). Depois de executar esses passos, o token recebido é habilitado possibiltando o usuário realizar requisições com acesso autenticado para ao [`SINM`](#api-zarc-nm). Esses passos devem serem realizados apenas na *collection* ***Endpoints API Zarcn-NM***, pois isso habilita o token em todos os endpoints presentes nessa *collection*. Adicionalmente, esse procedimento deve ser realizado todas as vezes que o token expirar.
<div align="center"> <div align="center">
...@@ -164,7 +164,7 @@ Por fim, clique no botão ***Use Token*** (*Cf*. retângulo amarelo, Figura 6). ...@@ -164,7 +164,7 @@ Por fim, clique no botão ***Use Token*** (*Cf*. retângulo amarelo, Figura 6).
Dados da gleba/talhão (propriedade, glebas, culturas e manejos). Essas informações são necessárias para dar início ao processo de classificção da gleba/talhão, para a qual se deseja obter o nível de manejo. Após realizar o processo de autenticação descrito na Subseção [`Autenticação de usuário`](#1-autenticação-de-usuário), use a plataforma [*Postman*](https://www.postman.com/) para enviar os dados da gleba/talhão. Dados da gleba/talhão (propriedade, glebas, culturas e manejos). Essas informações são necessárias para dar início ao processo de classificção da gleba/talhão, para a qual se deseja obter o nível de manejo. Após realizar o processo de autenticação descrito na Subseção [`Autenticação de usuário`](#1-autenticação-de-usuário), use a plataforma [*Postman*](https://www.postman.com/) para enviar os dados da gleba/talhão.
Para isso, clique em ***Dados da Gleba/Talhão*** , seguidamente em ***POST Glebas - Adicionar*** (*Cf*. retângulo rosa, Figura 7) e faça uma requisição [HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP) utilizando o método [POST](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Methods/POST) Para isso, clique em ***Dados da Gleba/Talhão*** , seguidamente em ***POST Glebas - Adicionar*** (*Cf*. retângulo rosa, Figura 7) e faça uma requisição [HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP) utilizando o método [POST](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Methods/POST)
para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 7). para o [`SINM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 7).
<div align="center"> <div align="center">
...@@ -174,15 +174,15 @@ para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 7). ...@@ -174,15 +174,15 @@ para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 7).
![postman-post-glebas](uploads/6a667cfcf86e7e90fdc892fd07c64b9e/postman-post-glebas.png) ![postman-post-glebas](uploads/6a667cfcf86e7e90fdc892fd07c64b9e/postman-post-glebas.png)
Após o envio da solicitação, se todas as informações enviadas no cabeçalho e no corpo da requisição foram informadas corretamente (*Cf*. retângulos laranja e amarelo, Figura 7), a [`API Zarc-NM`](#api-zarc-nm) retorna o código [201 Created - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201) informando que o recurso foi criado com sucesso. No corpo da resposta são retornados os dados que foram enviados na requisição e uma chave nomeada de chave da classificação de nível de manejo - ***chaveClassificacaoNM*** Após o envio da solicitação, se todas as informações enviadas no cabeçalho e no corpo da requisição foram informadas corretamente (*Cf*. retângulos laranja e amarelo, Figura 7), o [`SINM`](#api-zarc-nm) retorna o código [201 Created - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201) informando que o recurso foi criado com sucesso. No corpo da resposta são retornados os dados que foram enviados na requisição e uma chave nomeada de chave da classificação de nível de manejo - ***chaveClassificacaoNM***
que deverá ser guardada (*Cf*. retângulo azul, Figura 7). Esta chave será a identificação usada para envio posterior dos dados de análise de solo, de geoprocessamento e de consulta ao nível de manejo calculado. que deverá ser guardada (*Cf*. retângulo azul, Figura 7). Esta chave será a identificação usada para envio posterior dos dados de análise de solo, de geoprocessamento e de consulta ao nível de manejo calculado.
### 3. Envio de dados de análise de solo ### 3. Envio de dados de análise de solo
Dados de análise de solo (do conjunto de amostras de solo). Essas informações são necessárias para dar continuidade no processo de classificação após cadastro da(s) gleba(s). Para enviar estes dados, o usuário deve estar autenticado (*Cf*. Subseção [`Autenticação de usuário`](#1-autenticação-de-usuário)) e precisa ter a chave ***chaveClassificacaoNM*** gerada com o cadastro da gleba na etapa anterior (*Cf*. retângulo azul, Figura 7). Dados de análise de solo (do conjunto de amostras de solo). Essas informações são necessárias para dar continuidade no processo de classificação após cadastro da(s) gleba(s). Para enviar estes dados, o usuário deve estar autenticado (*Cf*. Subseção [`Autenticação de usuário`](#1-autenticação-de-usuário)) e precisa ter a chave ***chaveClassificacaoNM*** gerada com o cadastro da gleba na etapa anterior (*Cf*. retângulo azul, Figura 7).
Utilizando o [*Postman*](https://www.postman.com/), o usuário enviará uma solicitação para a [`API Zarc-NM`](#api-zarc-nm) passando a chave ***chaveClassificacaoNM***. Para isso, clique em ***Dados de Laboratório*** , seguidamente em ***POST Amostras - Adicionar*** (*Cf*. retângulo rosa, Figura 8) e faça uma requisição [HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP) utilizando o método [POST](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Methods/POST) Utilizando o [*Postman*](https://www.postman.com/), o usuário enviará uma solicitação para o [`SINM`](#api-zarc-nm) passando a chave ***chaveClassificacaoNM***. Para isso, clique em ***Dados de Laboratório*** , seguidamente em ***POST Amostras - Adicionar*** (*Cf*. retângulo rosa, Figura 8) e faça uma requisição [HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP) utilizando o método [POST](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Methods/POST)
para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 8). para o [`SINM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 8).
<div align="center"> <div align="center">
...@@ -192,15 +192,15 @@ para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 8). ...@@ -192,15 +192,15 @@ para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 8).
![postman-post-amostras](uploads/ee0d4115e6af0425f57b76b9173ff9ff/postman-post-amostras.png) ![postman-post-amostras](uploads/ee0d4115e6af0425f57b76b9173ff9ff/postman-post-amostras.png)
Após o envio da solicitação, se todas as informações enviadas no cabeçalho e no corpo da requisição foram informadas corretamente (*Cf*. retângulos laranja e amarelo, Figura 8), a [`API Zarc-NM`](#api-zarc-nm) retorna o código [201 Created - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201) informando que o recurso foi criado com sucesso. No corpo da resposta são retornados os dados que foram enviados na requisição (*Cf*. retângulo amarelo, Figura 8). Após o envio da solicitação, se todas as informações enviadas no cabeçalho e no corpo da requisição foram informadas corretamente (*Cf*. retângulos laranja e amarelo, Figura 8), o [`SINM`](#api-zarc-nm) retorna o código [201 Created - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201) informando que o recurso foi criado com sucesso. No corpo da resposta são retornados os dados que foram enviados na requisição (*Cf*. retângulo amarelo, Figura 8).
*Os dados de análise de solo enviados para uma chave de classificação de nível de manejo podem ser enviados apenas uma única vez (futuramente haverá recursos para retificação)*. <!-- *Os dados de análise de solo enviados para uma chave de classificação de nível de manejo podem ser enviados apenas uma única vez (futuramente haverá recursos para retificação)*. -->
### 4. Envio de dados de sensoriamento remoto ### 4. Envio de dados de sensoriamento remoto
Dados de sensoriamento remoto relacionados à gleba/talhão para a qual foi solicitada uma classificação de nível de manejo. Os dados de geoprocessamento serão necessários para validar as informações fornecidas pelo agente do contrato no processo de classificação das glebas/talhões. Para realizar o envio desses dados, o usuário deve estar autenticado (*Cf*. Subseção [`Autenticação de usuário`](#1-autenticação-de-usuário)) e precisa ter a chave ***chaveClassificacaoNM*** gerada com o cadastro da gleba na etapa anterior (*Cf*. retângulo azul, Figura 7). Dados de sensoriamento remoto relacionados à gleba/talhão para a qual foi solicitada uma classificação de nível de manejo. Os dados de geoprocessamento serão necessários para validar as informações fornecidas pelo agente do contrato no processo de classificação das glebas/talhões. Para realizar o envio desses dados, o usuário deve estar autenticado (*Cf*. Subseção [`Autenticação de usuário`](#1-autenticação-de-usuário)) e precisa ter a chave ***chaveClassificacaoNM*** gerada com o cadastro da gleba na etapa anterior (*Cf*. retângulo azul, Figura 7).
Utilizando o [*Postman*](https://www.postman.com/), o usuário enviará uma solicitação para a [`API Zarc-NM`](#api-zarc-nm) passando a chave ***chaveClassificacaoNM***. Para isso, clique em ***Dados de Sensoriamento Remoto*** , seguidamente em ***POST Monitoramentos - Adicionar*** (*Cf*. retângulo rosa, Figura 9) e faça uma requisição [HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP) utilizando o método [POST](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Methods/POST) Utilizando o [*Postman*](https://www.postman.com/), o usuário enviará uma solicitação para o [`SINM`](#api-zarc-nm) passando a chave ***chaveClassificacaoNM***. Para isso, clique em ***Dados de Sensoriamento Remoto*** , seguidamente em ***POST Monitoramentos - Adicionar*** (*Cf*. retângulo rosa, Figura 9) e faça uma requisição [HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP) utilizando o método [POST](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Methods/POST)
para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 9). para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 9).
<div align="center"> <div align="center">
...@@ -211,15 +211,15 @@ para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 9). ...@@ -211,15 +211,15 @@ para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 9).
![postman_post_monitoramento](uploads/dcb2293c9a9507e78149b233b2f3ae21/postman_post_monitoramento.png) ![postman_post_monitoramento](uploads/dcb2293c9a9507e78149b233b2f3ae21/postman_post_monitoramento.png)
Após o envio da solicitação, se todas as informações enviadas no cabeçalho e no corpo da requisição foram informadas corretamente (*Cf*. retângulos laranja e amarelo, Figura 9), a [`API Zarc-NM`](#api-zarc-nm) retorna o código [201 Created - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201) informando que o recurso foi criado com sucesso. No corpo da resposta são retornados os dados que foram enviados na requisição (*Cf*. retângulo amarelo, Figura 9). Além disso, logo após o envio desses dados, é realizado o cálculo da classificação de nível de manejo para a gleba/talhão referente a chave informada. E o usuário pode consultar o resultado da classifição na [`API Zarc-NM`](#api-zarc-nm)(*Cf*. Subseção [`Classificação nível manejo`](#2-classificação-nível-manejo)). Após o envio da solicitação, se todas as informações enviadas no cabeçalho e no corpo da requisição foram informadas corretamente (*Cf*. retângulos laranja e amarelo, Figura 9), o [`SINM`](#api-zarc-nm) retorna o código [201 Created - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201) informando que o recurso foi criado com sucesso. No corpo da resposta são retornados os dados que foram enviados na requisição (*Cf*. retângulo amarelo, Figura 9). Além disso, logo após o envio desses dados, é realizado o cálculo da classificação de nível de manejo para a gleba/talhão referente a chave informada. E o usuário pode consultar o resultado da classifição no [`SINM`](#api-zarc-nm)(*Cf*. Subseção [`Classificação nível manejo`](#2-classificação-nível-manejo)).
*Os dados de sensoriamento remoto enviados para uma chave de classificação de nível de manejo podem ser enviados apenas uma única vez (futuramente haverá recursos para retificação).* <!-- *Os dados de sensoriamento remoto enviados para uma chave de classificação de nível de manejo podem ser enviados apenas uma única vez (futuramente haverá recursos para retificação).* -->
### 2. Classificação nível manejo ### 2. Classificação nível manejo
Uma vez que o registro dos dados obrigatórios tenha sido finalizado e o cálculo da classificação tenha sido realizado, é possível consultar a classificação do nível de manejo de uma determinada gleba/talhão na [`API Zarc-NM`](#api-zarc-nm). Para a consulta, o usuário deve estar autenticado (*Cf*. Subseção [`Autenticação de usuário`](#1-autenticação-de-usuário)) e precisa ter a chave ***chaveClassificacaoNM*** gerada com o cadastro de uma determinada gleba/talhão (*Cf*. retângulo azul, Figura 7). Uma vez que o registro dos dados obrigatórios tenha sido finalizado e o cálculo da classificação tenha ocorrido, é possível consultar a classificação do nível de manejo de uma determinada gleba/talhão no [`SINM`](#api-zarc-nm). Para a consulta, o usuário deve estar autenticado (*Cf*. Subseção [`Autenticação de usuário`](#1-autenticação-de-usuário)) e precisa ter a chave ***chaveClassificacaoNM*** gerada com o cadastro de uma determinada gleba/talhão (*Cf*. retângulo azul, Figura 7).
Utilizando o [*Postman*](https://www.postman.com/), o usuário enviará uma solicitação para a [`API Zarc-NM`](#api-zarc-nm) passando a chave ***chaveClassificacaoNM***. Para isso, clique em ***Classificação Nível Manejo*** , seguidamente em ***GET Classificações - Buscar*** (*Cf*. retângulo vermelho, Figura 10) e faça uma requisição [HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP) utilizando o método [GET](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Methods/GET) Utilizando o [*Postman*](https://www.postman.com/), o usuário enviará uma solicitação para o [`SINM`](#api-zarc-nm) passando a chave ***chaveClassificacaoNM***. Para isso, clique em ***Classificação Nível Manejo*** , seguidamente em ***GET Classificações - Buscar*** (*Cf*. retângulo vermelho, Figura 10) e faça uma requisição [HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP) utilizando o método [GET](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Methods/GET)
para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 10). para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 10).
<div align="center"> <div align="center">
...@@ -230,13 +230,13 @@ para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 10). ...@@ -230,13 +230,13 @@ para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 10).
![postman-get-classificacoes](uploads/0c95d0877a42be7a9b4b5b69ef4ef022/postman-get-classificacoes.png) ![postman-get-classificacoes](uploads/0c95d0877a42be7a9b4b5b69ef4ef022/postman-get-classificacoes.png)
Após o envio da solicitação, se todas as informações enviadas no cabeçalho da requisição foram informadas corretamente (*Cf*. retângulo laranja, Figura 10) , a [`API Zarc-NM`](#api-zarc-nm) retorna o código [200 OK - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) informando que o recurso foi encontrado. No corpo da resposta é retornado o nível de manejo, a data e hora em que foi realizado o cálculo da classificação (*Cf*. retângulo amarelo, Figura 10). Se o usuário tentar consultar o resultado de uma classificação que ainda não foi finalizada, a [`API Zarc-NM`](#api-zarc-nm) retorna o código [404 Not Found - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404) indicando que o recurso foi encontrado Após o envio da solicitação, se todas as informações enviadas no cabeçalho da requisição foram informadas corretamente (*Cf*. retângulo laranja, Figura 10) , o [`SINM`](#api-zarc-nm) retorna o código [200 OK - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) informando que o recurso foi encontrado. No corpo da resposta é retornada a chave da classificação (***chaveClassificacaoNM***), o score final (nível de manejo), a data e hora em que foi realizado o cálculo da classificação e uma lista de inconsistências (tipo, descrição e a data e hora do registro das inconsistências), se houver dados inconsistentes. (*Cf*. retângulo amarelo, Figura 10). Se o usuário tentar consultar o resultado de uma classificação que ainda não foi finalizada, o [`SINM`](#api-zarc-nm) retorna o código [404 Not Found - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404) indicando que o recurso foi encontrado e uma mensagem informando qual ou quais dado(s) estão faltando para finalizar o cálculo de classificação de nível de manejo.
### 6. Lista de culturas ### 6. Lista de culturas
Para enviar os dados de uma determinada gleba/talhao (*Cf*. Subseção [`Envio de dados da gleba/talhão`](#2-envio-de-dados-da-glebatalhão)), é preciso informar as culturas cultivadas na gleba/talhão durante o período de três anos. Essa informação é adicionada no campo ***nome***, do objeto ***cultura*** presente na lista de ***producoes*** que compõe os dados da gleba/talhão (*Cf*. retângulo amarelo, Figura 7). Para enviar os dados de uma determinada gleba/talhao (*Cf*. Subseção [`Envio de dados da gleba/talhão`](#2-envio-de-dados-da-glebatalhão)), é preciso informar as culturas cultivadas na gleba/talhão durante o período de três anos. Essa informação é adicionada no campo ***nome***, do objeto ***cultura*** presente na lista de ***producoes*** que compõe os dados da gleba/talhão (*Cf*. retângulo amarelo, Figura 7).
Para auxiliar o usuário na hora de adicionar essa informação, a [`API Zarc-NM`](#api-zarc-nm) disponibiliza uma lista com os nomes das culturas que ela aceita. Utilizando o [*Postman*](https://www.postman.com/), o usuário enviará uma requisição para a [`API Zarc-NM`](#api-zarc-nm) solicitando a lista de culturas. Para isso, clique em ***Culturas*** , seguidamente em ***GET Culturas - Listar*** (*Cf*. retângulo rosa, Figura 11) e faça uma requisição [HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP) utilizando o método [GET](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Methods/GET) Para auxiliar o usuário na hora de adicionar essa informação, o [`SINM`](#api-zarc-nm) disponibiliza uma lista com os nomes e códigos das culturas que ele aceita. Utilizando o [*Postman*](https://www.postman.com/), o usuário enviará uma requisição para o [`SINM`](#api-zarc-nm) solicitando a lista de culturas. Para isso, clique em ***Culturas*** , seguidamente em ***GET Culturas - Listar*** (*Cf*. retângulo rosa, Figura 11) e faça uma requisição [HTTP](https://developer.mozilla.org/pt-BR/docs/Web/HTTP) utilizando o método [GET](https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Methods/GET)
para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 11). para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 11).
<div align="center"> <div align="center">
...@@ -247,11 +247,11 @@ para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 11). ...@@ -247,11 +247,11 @@ para a [`API Zarc-NM`](#api-zarc-nm). (*Cf*. retângulo laranja, Figura 11).
![postman-get-culturas](uploads/fb4265b4166770d12075bec087d118c9/postman-get-culturas.png) ![postman-get-culturas](uploads/fb4265b4166770d12075bec087d118c9/postman-get-culturas.png)
Após o envio da solicitação, se todas as informações enviadas no cabeçalho da requisição foram informadas corretamente (*Cf*. retângulo laranja, Figura 11), a [`API Zarc-NM`](#api-zarc-nm) retorna o código [200 OK - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) informando que o recurso foi encontrado. No corpo da resposta é retornada a lista contendo todos os nomes das culturas (*Cf*. retângulo amarelo, Figura 11). Após o envio da solicitação, se todas as informações enviadas no cabeçalho da requisição foram informadas corretamente (*Cf*. retângulo laranja, Figura 11), o [`SINM`](#api-zarc-nm) retorna o código [200 OK - HTTP Status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) informando que o recurso foi encontrado. No corpo da resposta é retornada a lista contendo todos os nomes e códigos das culturas (*Cf*. retângulo amarelo, Figura 11).
## Dados contidos no *template* da *collection* disponibilazada ## Dados contidos no *template* da *collection* disponibilazada
Para cada *endpoint* da API ZarcNM, disponibilizamos uma [*collection* do Postman](uploads/ad50786717f29582043e50549096b7b5/Endpoints_API_Zarc-NM-sem-credenciais.postman_collection.json), foi criado um *template* com dados simulados, com a finalidade apenas de testar o envio de dados e também exemplificar os dados e os tipos de dados que a [`API Zarc-NM`](#api-zarc-nm) recebe. Para cada *endpoint* do SINM, disponibilizamos uma [*collection* do Postman](uploads/ad50786717f29582043e50549096b7b5/Endpoints_API_Zarc-NM-sem-credenciais.postman_collection.json), foi criado um *template* com dados simulados, com a finalidade apenas de testar o envio de dados e também exemplificar os dados e os tipos de dados que o [`SINM`](#api-zarc-nm) recebe.
## Links úteis ## Links úteis
......