Introdução

Esta documentação cobre a API REST da AgFlow, organizada por domínio de negócio (Fluxo, Fase, Cards, Clientes, Motores, entre outros). Antes de usar qualquer endpoint, esta página explica como obter acesso, qual URL base utilizar e como localizar os identificadores exigidos pelos caminhos das rotas.

URL base

Todas as chamadas descritas nesta documentação usam a URL base:

https://api.agflow.agrisk.app

O caminho de cada endpoint documentado (ex: /v1/clients) deve ser combinado com essa URL base — por exemplo, GET /v1/clients corresponde à chamada completa GET https://api.agflow.agrisk.app/v1/clients.

Autenticação

O login usa uma URL diferente da URL base da API, dedicada exclusivamente à autenticação:

POST https://agflow.agrisk.app/api/login

Corpo da requisição:

{
  "credential": "<seu-email-de-acesso>",
  "password": "<sua-senha>"
}

A resposta traz um token de acesso no campo accessToken. Esse token deve ser enviado em toda chamada subsequente à API, no cabeçalho Authorization:

Authorization: Bearer <accessToken>

O token tem validade limitada; ao expirar, repita o login para obter um novo.

Como localizar os identificadores usados nos endpoints

A maioria dos caminhos de endpoint contém identificadores entre chaves (ex: {clientId}, {cardId}, {flowId}). Esses valores não são inventados nem escolhidos livremente — eles vêm sempre da resposta de um endpoint de listagem ou consulta anterior:

Identificador	Onde obter
`flowId`	`GET /v1/flows`, ou a URL do flow dentro da aplicação AgFlow
`cardId`	Listagem de cards de um flow ou de uma fase (domínio Cards)
`clientId`	`GET /v1/clients` (domínio Clientes), ou a listagem de clientes de um card específico
`phaseId`, `templateId` e demais	Sempre por uma chamada de leitura do domínio correspondente — nunca definidos livremente pelo consumidor da API

Cabeçalhos e convenções gerais

Toda requisição autenticada exige o cabeçalho Authorization: Bearer <accessToken>.

Alguns endpoints aceitam também um cabeçalho ag-flow-id, identificando um flow de referência. Quando um endpoint específico documenta esse cabeçalho, ele é opcional, salvo indicação contrária explícita naquele endpoint.

Toda requisição e resposta usa JSON (Content-Type: application/json).

Organização desta documentação

Os endpoints estão agrupados por domínio de negócio, replicados em duas árvores paralelas — 🇧🇷 Português e 🇺🇸 English — com o mesmo conteúdo técnico, apenas o idioma da descrição muda. Cada domínio tem um documento de "Visão geral" no topo, seguido dos endpoints individuais daquele domínio.

URL base#

Autenticação#

Como localizar os identificadores usados nos endpoints#

Cabeçalhos e convenções gerais#

Organização desta documentação#

URL base

Autenticação

Como localizar os identificadores usados nos endpoints

Cabeçalhos e convenções gerais

Organização desta documentação