API para desenvolvedores

Integre o agro brasileiro na sua stack

Uma API REST completa para crédito rural, monitoramento de safra por satélite, marketplace, cotações e ESG. Autentique com API Key, teste na documentação interativa e vá para produção.

Documentação interativa Gerar chave de API OpenAPI (JSON)

RESTful & JSON

Padrão REST previsível com respostas JSON. Integra com qualquer stack.

API Key ou JWT

X-API-Key para servidor-a-servidor; JWT para apps de usuário.

HTTPS + LGPD

Toda comunicação criptografada (TLS) e conforme a LGPD.

Rate limit justo

60 req/min por chave, com erro 429 claro e revogação instantânea.

Comece em 3 passos

1

Gere sua chave

No painel, vá em Configurações → Chaves de API e crie uma chave. Copie o segredo (ck_live_…) — ele só aparece uma vez.

2

Autentique

Envie o header X-API-Key em cada requisição. Sem expiração, revogável a qualquer momento.

3

Faça a 1ª chamada

Consuma qualquer endpoint da API. Teste tudo na documentação interativa antes de ir a produção.

URL base

https://conectcampo.digital/api/v1
Swagger interativo Especificação OpenAPI

Autenticação

API Key (integrações)

Recomendado para servidor-a-servidor. Envie o header X-API-Key em toda requisição. Cada chave tem scopes (read/write) e pode ter expiração. Chaves só de leitura não executam POST/PATCH/DELETE.

curl https://conectcampo.digital/api/v1/farms \
  -H "X-API-Key: ck_live_xxxxxxxxxxxxxxxx"

Bearer JWT (apps)

Obtenha o token em /auth/login e envie no header Authorization.

curl https://conectcampo.digital/api/v1/farms \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

Endpoints

Principais recursos abaixo. A lista completa e testável está na documentação interativa.

Autenticação

POST/auth/register
POST/auth/login
POST/auth/refresh
GET/auth/me

Chaves de API

GET/api-keys
POST/api-keys
DELETE/api-keys/:id

Fazendas & Talhões

GET/farms
POST/farms
GET/farms/summary
POST/farms/:id/plots
DELETE/farms/plots/:id

Monitoramento por satélite

POST/ndvi/plots/:plotId/generate
GET/ndvi/plots/:plotId
GET/weather/forecast
GET/climate-score/:farmId

Crédito, Score & Match

GET/operations
POST/operations
GET/scoring/:id
GET/matching/:operationId
GET/cpr

Mercado & Financeiro

GET/marketplace/listings
POST/marketplace/orders
GET/quotes
POST/quotes/alerts
GET/cashflow

Documentos & ESG

POST/documents/upload
POST/smart-docs/extract
GET/carbon-credits

Exemplos por linguagem

cURL

curl https://conectcampo.digital/api/v1/quotes \
  -H "X-API-Key: $CONECTCAMPO_KEY"

JavaScript (fetch)

const res = await fetch(
  "https://conectcampo.digital/api/v1/quotes",
  { headers: { "X-API-Key": process.env.CONECTCAMPO_KEY } }
);
const data = await res.json();

Python (requests)

import os, requests

r = requests.get(
    "https://conectcampo.digital/api/v1/quotes",
    headers={"X-API-Key": os.environ["CONECTCAMPO_KEY"]},
)
data = r.json()

Erros

Erros retornam JSON no formato { statusCode, message, error }.

400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
429Too Many Requests
500Server Error

Rate limit & paginação

  • Limite padrão de 60 requisições/minuto por chave (ou por IP, sem chave).
  • Cada resposta traz X-RateLimit-Limit/Remaining/Reset.
  • Ao exceder, a API responde 429 Too Many Requests com Retry-After.
  • Toda resposta inclui X-Request-Id para correlação/suporte.
  • Listagens aceitam ?page e ?perPage, retornando { data, meta }.
  • Revogue chaves comprometidas a qualquer momento no painel.

Pronto para integrar?

Gere sua chave de API no painel e explore todos os endpoints na documentação interativa.

Gerar chave de API Abrir Swagger