API pública v1

A API pública da OctoSolve permite consultar, criar e atualizar contatos por HTTP. Ela foi feita para integrações próprias e automações em ferramentas como Make e n8n.

URL base: https://api.octosolve.com.br/api/v1

Contrato OpenAPI: https://api.octosolve.com.br/api/v1/openapi.json

Como as respostas funcionam

Um item bem-sucedido fica dentro de data:

{
  "data": {
    "id": "018f6d6e-7b55-7d61-8bd0-1b2c3d4e5f60",
    "nome": "Maria Silva"
  }
}

Uma lista também informa se existe outra página:

{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Erros usam sempre o campo error, com código estável em inglês, mensagem em português e um request_id para diagnóstico. Corpos de requisição usam application/json, com tamanho máximo de 64 KB. Datas e horários são ISO 8601 em UTC, com fuso, e identificadores são UUIDs.

Política de evolução

Mudanças aditivas não quebram a v1. Isso inclui um novo campo opcional em uma resposta e um novo valor em um enum documentado como expansível. Seu código deve ignorar campos desconhecidos e estar preparado para novos valores de enum.

Remover ou renomear um campo, mudar seu tipo ou tornar obrigatório o que hoje é opcional exige uma nova versão, como /api/v2.

Quando uma versão ou funcionalidade for descontinuada, a OctoSolve dará aviso mínimo de 6 meses no changelog e nesta documentação.

Primeiro teste com curl

O exemplo usa uma chave fictícia com formato válido. Troque pela chave exibida no painel antes de executar.

curl --request GET \
  --url "https://api.octosolve.com.br/api/v1/contacts?limit=1" \
  --header "Authorization: Bearer osk_live_exemplo_ficticio_00000000000000000000000000" \
  --header "Accept: application/json"

Primeiro teste no Make ou n8n

1. Adicione um módulo HTTP > Make a request no Make ou um nó HTTP Request no n8n.
2. Escolha o método GET.
3. Use a URL https://api.octosolve.com.br/api/v1/contacts?limit=1.
4. Adicione o header Authorization com o valor Bearer SUA_CHAVE.
5. Adicione o header Accept com o valor application/json.
6. Execute uma vez e use os itens de data nos próximos passos do cenário ou workflow.

Continue por aqui

• Autenticação e chaves
• Limites de requisições
• Erros
• Paginação
• Contatos