Perguntas
Frequentes
Encontre respostas para suas dúvidas
Uso das APIs
SUMÁRIO​
Todas as chamadas abaixo devem ser feitas utilizando este endereço como base, seguido pelo path correspondente do endpoint.
2 - Autenticação e Atualização do Token
2.1 - Autenticação Para uso das APIs
Você deve utilizar a API de autenticação por usuário e senha. Na resposta, terá o token de acesso (accessToken) que deverá ser usado para utilizar as APIs:
​
-
Endpoint:
POST /auth/by/username/password
​🔗 Swagger
​
-
Body esperado:
{
"username": "seu_usuario",
"password": "sua_senha"
}
-
Resposta esperada:
{
"accessToken": "JWT_ACCESS_TOKEN",
"idToken": "JWT_ID_TOKEN (opcional)",
"refreshToken": "JWT_REFRESH_TOKEN (opcional)"
}
​
-
Os tokens são do tipo JWT;
-
O accessToken expira em 1 hora;
-
idToken é opcional (necessário apenas se for requisitado nos callbacks);
O refreshToken deve ter validade mínima de 30 dias
​​
2.2 - Atualização do Token de Acesso
O token tem tempo de expiração de 1 hora. Para continuar usando as APIs, use a API de refresh token, para atualizar o token de autenticação:
​
-
Endpoint:
POST /auth/by/refresh-token
​
-
Body esperado:
{
"refreshToken": "JWT_REFRESH_TOKEN"
}
-
Resposta esperada:
{
"accessToken": "NOVO_ACCESS_TOKEN",
"idToken": "NOVO_ID_TOKEN (opcional)"
}
​​
-
Autenticação (Tokens JWT)
-
Qual o tempo de expiração do token?
-
​O accessToken expira em 1 hora.
-
O token de acesso pode ser atualizado (via API do refreshToken) por 30 dias.
-
-
2.3 - Principais Dúvidas
3 - Requisição de Seguro
3.1 - Como Criar Uma Requisição Via API
3.2- Como Criar Uma Requisição Via API
{
"companyId": 1, // Id da companhia
"companySectorId": 1, // Id do setor da companhia
"insuranceReportRequestTypeId": 1, // Id do tipo de requisição
"customer": {
"name": "João Silva",
"phoneNumber": "83988234563", // OPCIONAL
"birthDate": "2003-06-09", // OPCIONAL
"email": "user@gmail.com",
"carriedActivity": "Responsável auxiliar", // OPCIONAL
"documents": [
{
"code": "CPF", // Também pode ser “CNPJ”
"value": "10098767656" // Número do CPF ou CNPJ
}
]
},
"contract": {
"insuranceContractTypeId": 1, // Id do tipo de contrato (1-Proposal/ 2-Contract/ 3-Policy)
"code": "1vcfd55", // CÓDIGO DO CONTRATO
"startDate": "2024-08-15", // Data de início do contrato
"endDate": "2024-12-15" // Data de término do contrato
},
"properties": [
{
"code": "Fazenda Sítio do Pica Pau Amarelo", // Nome da Propriedade
"ruralEnvironmentalRegistry": {
"code": "UF-1302405-E6D3.395B.6D27.4F42.AE22.DD56.987C.DD52", // Código do CAR (OPCIONAL)
"geometryFileUrl": "string" // Anexo do arquivo de geometria da área do CAR (OPCIONAL)
},
"fields": [
{
"code": "Field I", // Nome da área
"area": 1000.5, // Área estimada da área
"productId": 10, // ID do Produto
"plantingDate": "2021-12-15", // Data de plantio
"pruningDate": "2022-05-15", // Data de poda (OPCIONAL)
"harvestDate": "2022-04-15", // Data de colheita
"geometryFileUrl": "https://storage.googleapis.com/private-attachment-cyan-agro/...", // Anexo do arquivo da geometria da área
"insuranceSoilIds": [ // IDs de tipos de solos
1,
2,
3
],
"insuranceCultivarGroupIds": [ // IDs de tipos de grupos
4,
2,
1
]
}
]
}
]
}
3.3 - Obtendo os IDs e URLs de Anexo
-
Para saber os IDs dos tipos de requisição, consulte o tópico 4.
-
Para saber os IDs dos tipos de Produtos, consulte o tópico 5.
-
Para obter uma URL de um arquivo para anexo, utilize a API do tópico 6.
4 - Quais Tipos de Relatório Posso Solicitar?
Utilize esta API para receber os tipos de requisições disponíveis para a companhia especificada, passando o ID da companhia:
​
-
Endpoint:
GET /insurance/report-request-type/by/company-id
🔗 Swagger
5 - Quais Produtos Posso Informar no Relatório?
Utilize esta API para receber todos os Produtos disponíveis no nosso sistema:
​
-
Endpoint:
GET /product
🔗 Swagger
6 - Como Fazer Upload de Arquivos (Anexos do Relatório)?
Utilize este endpoint para enviar um arquivo para o armazenamento em nuvem (Google Cloud). O arquivo deve ser compactado com o algoritmo deflate e codificado em base64.A resposta trará a URL pública do arquivo, que deve ser usada nas APIs que exigem anexos.
​
-
Endpoint:
POST /attachment/upload/v2
🔗 Swagger
7 - Quais Tipos de Contrato Posso Inserir na Requisição?
Utilize esta API para obter todos os tipos de contrato disponíveis na nossa base de dados.
​
-
Endpoint:
GET /insurance/contract-type
8 - Tipos de Solo e Tipos de Grupo
​​​
​
-
Grupo I​
-
Grupo II
-
Grupo III
-
Grupo IV
8.1 - Tipos Grupo (ID - Nome)
​
8.2 - Tipos de Solo (ID - Nome)
1 - Arenoso
2 - Textura Média
3 - Argiloso
4 - AD1
5 - AD2
6 - AD3
7 - AD4
8 - AD5
9 - AD6
8.2 - Obrigatoriedade
Estes dados são obrigatórios apenas quando os seguintes casos são atendidos:
​
-
Tipo de requisição: “PÓS SAFRA”;
-
Produto informado é um dos produtos classificados ou avaliados com base no Zoneamento Agrícola de Risco Climático (ZARC) — uma metodologia oficial usada no Brasil pelo MAPA (Ministério da Agricultura).