SUMÁRIO
-
Endereço Base da API
-
Autenticação e Atualização do Token
-
Requisição de Seguro
-
Quais Tipos de Relatório Posso Solicitar?
-
Quais Produtos Posso Informar no Relatório?
-
Como Fazer Upload de Arquivos (anexos do relatório)?
-
Quais Tipo de Contrato Posso Inserir na Requisição?
-
Tipos de Solos e Tipos de Grupo
AGRO ANALYTICS E INFRAESTRUTURA
Monitoramento de Incêndio
Alertas antecipados e rotas otimizadas por meio de câmeras e satélites em áreas de risco.
Nossas soluções para o agro
Uso das APIs
5 - Resumo de Erros e Troubleshooting (FAQ)
"
1- Visão Geral
1- Endereço Base da API
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
🔗 https://api.cyan-agro.com/swagger-ui/index.html#/Authentication/authenticateByUsernameAndPassword
-
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
🔗 https://api.cyan-agro.com/swagger-ui/index.html#/Authentication/authenticateByUsernameAndPassword
-
Body esperado:
{
"refreshToken": "JWT_REFRESH_TOKEN"
}
-
Resposta esperada:
{
"accessToken": "NOVO_ACCESS_TOKEN",
"idToken": "NOVO_ID_TOKEN (opcional)"
}
2.3 - Principais Dúvidas
-
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.
-
-
3 - Requisição de Seguro
3.1 - Como Criar Uma Requisição Via API
Use o endpoint:
-
Endpoint:
POST /insurance/report-request
🔗 https://api.cyan-agro.com/swagger-ui/index.html#/Authentication/authenticateByUsernameAndPassword
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
🔗 https://api.prod.cyan-agro.com/swagger-ui/index.html#/Insurance%20Report%20Request%20Type/findByCompanyId
5 - Quais Produtos Posso Informar no Relatório?
Utilize esta API para receber todos os Produtos disponíveis no nosso sistema:
-
Endpoint:
GET /product
🔗 https://api.cyan-agro.com/swagger-ui/index.html#/Product/findDto
6 - Como Fazer Upload de Arquivos (Anexos do Relatório)?
Utilize este endpoint para enviar arquivos para o armazenamento em nuvem (Google Cloud).
Os arquivos devem obrigatoriamente estar compactados e codificados em base64 antes do envio.
A API oferece suporte aos seguintes modelos de compactação:
-
Zlib
-
Gzip
-
Zip
Após o upload, a API retornará a URL pública do arquivo, que deverá ser utilizada nas demais APIs que exigem anexos.
Uma propriedade pode conter mais de uma área, com uma distância máxima de até 80km entre as áreas.
-
Endpoint:
POST /attachment/upload/v2
🔗 https://api.cyan-agro.com/swagger-ui/index.html#/Attachment/uploadV2
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
🔗https://api.cyan-agro.com/swagger-ui/index.html#/Insurance%20Contract%20Type/findAll
8 - Tipos de Solo e Tipos de Grupo
8.1 - Tipos Grupo (ID - Nome)
-
Grupo I
-
Grupo II
-
Grupo III
-
Grupo IV
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.3 - 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).
1 - Como acessar o Portal do Suporte
Resposta: Você pode acessar o Portal do Suporte clicando aqui. Ou se preferir, pode acessar o Portal quando logado no dashboard Cyan, clicando no ícone de engrenagem (configurações) no canto inferior da barra lateral, e em seguida, em “Suporte” e “Portal de Suporte”.
2 - Como relatar um problema ou BUG?
Resposta: No Portal do Suporte, clique em “Relatar um problema”. É importante descrever com clareza sobre o problema que está enfrentando. A equipe de suporte receberá seu chamado e responderá o mais rápido possível.
3 - Como solicitar suporte técnico?
Resposta: No Portal do Suporte, clique em “Suporte Técnico”. Informe sua unidade e descreva o contexto da solicitação. Este chamado pode ser usado para solicitação de implementações, como códigos de caminhões, nomes no relatório de incêndio, e até mesmo integrações.
Para problemas mais específicos, selecione a opção “Outras questões”, ou sugira melhorias, clicando em “Sugerir melhoria”.
4 - Níveis de prioridade
Resposta: Ao criar um ticket, o usuário deve selecionar o nível de prioridade da solicitação, de acordo com a urgência e impacto da demanda. A equipe de T.I realizará uma análise criteriosa, em colaboração com a equipe de Produto, para validar a prioridade informada. Caso a prioridade selecionada pelo usuário não esteja condizente com o impacto real da solicitação, o tempo de resolução esperado pode ser diferente. Os níveis de prioridade, tempos estimados de resolução e exemplos de situações são descritos abaixo:
Tempo máximo para a primeira resposta: 2 horas (horário comercial)
-
Muito Alto (Highest)
-
A solicitação é extremamente urgente e crítica, necessitando atenção imediata, pois está causando ou pode causar interrupções significativas em serviços essenciais.
-
Tempo para resolução: Até 5 horas (horário comercial).
-
-
Alto (High)
-
A solicitação é importante e deve ser tratada com prioridade, mas não compromete imediatamente as operações críticas da equipe de T.I.
-
Tempo para resolução: De 1 a 2 dias (horário comercial).
-
-
Médio (Medium)
-
A solicitação é de impacto moderado e não necessita de uma resposta imediata. Pode ser atendida sem comprometer o fluxo de trabalho.
-
Tempo para resolução: De 3 a 7 dias (horário comercial).
-
-
Baixo (Low)
-
A solicitação é de baixa prioridade, com impacto pequeno ou nulo no dia a dia da usabilidade.
-
Tempo para resolução: De 10 a 30 dias (horário comercial).
-
-
Muito Baixo (Lowest)
-
A solicitação é de prioridade mínima, geralmente de impacto insignificante ou que pode ser atendida em janelas específicas de menor atividade.
-
Tempo para resolução: Até 60 dias (horário comercial).
-
5 - Diferenças entre problemas internos do Cyan e problemas de máquina/rede do usuário
Resposta: Aqui estão algumas maneiras de diferenciar entre problemas internos do site e questões relacionadas à máquina ou rede do usuário.
Problemas Internos do Site:
-
Os problemas internos do site geralmente afetam todos os usuários, não apenas um.
-
Mensagens de erro específicas do site, como "Solicitação Incorreta" ou "Erro 404", indicam que o problema está do lado do Cyan.
-
Se outros sites estão funcionando corretamente e apenas um está apresentando problemas, é provável que o problema seja interno ao site do Cyan.
-
Falta de dados (como áreas da unidade em branco nos mapas do Cyan ou gráficos em branco).
Problemas de Máquina ou Rede do Usuário:
-
Se o problema ocorre em um único dispositivo, é mais provável que seja um problema local.
-
Problemas de conexão com a internet, como uma rede lenta ou intermitente, podem ser indicativos de problemas na rede do usuário.
-
Mensagens de erro genéricas, como "Sem conexão com a internet" ou "Página não pode ser exibida", geralmente apontam para problemas do lado do usuário.
-
Páginas do Cyan com erros de carregamento.
-
Falha ao reproduzir vídeos (como o de imagens de satélite no módulo de ‘Previsão’) no dashboard.
Para identificar a origem do problema, o usuário pode tentar acessar o site de diferentes dispositivos ou redes. Se o problema persistir em todos os dispositivos ou redes, é mais provável que seja um problema interno do site. Se o problema ocorrer apenas em um dispositivo ou rede específica, é provável que seja um problema local. É importante contatar a equipe de T.I da usina para validar erros internos e resolvê-los. Se após essa validação, for constatado que o erro é do Cyan, é recomendado abrir um ticket pelo Portal do Suporte.
6 - Horário do Suporte e contatos
-
Suporte Comercial: segunda a domingo, em horário comercial.
-
Suporte de TI: segunda a sexta, em horário comercial.
Quem Somos
Perguntas Frequentes
Portal do Suporte
@2026 CYAN ANALYTICS
Rua República do Iraque, 40, conj. 309 - Jardim Oswald Cruz
São José dos Campos - SP
CEP: 12216-540
Avenida Luiz Eduardo Toledo Prado – Vila do Golfe
Torre Empresarial II, nº 870 – Salas 308/309
Ribeirão Preto - SP
CEP: 14.027-250
Atendimento
De segunda a sexta das 8h às 17h
Sábados das 9h às 14h
+55 11 94168-8856
+55 11 3842-9444
+55 11 5583-0652
Quem Somos
Suporte e Ajuda
Perguntas Frequentes
Portal do Suporte
Quer uma solução completa para uma gestão mais eficiente?
Preencha o formulário para que um especialista da Cyan entre em contato com você.