Introdução

Hunter Sub API

Introdução

Nossa API foi desenvolvida com foco em simplicidade e eficiência, seguindo os padrões REST para garantir uma integração rápida e compatível com diferentes sistemas. Todas as respostas são retornadas em formato JSON, oferecendo uma estrutura consistente, legível e de fácil manipulação para desenvolvedores.

Autenticação

Para acessar a API, é necessário utilizar a chave secreta fornecida durante o processo de integração. A autenticação segue o padrão Basic Access Authentication.

Você pode localizar suas credenciais no painel da sua conta, acessando IntegraçõesChave de API, onde encontrará:

  • Secret Key → utilizada como o username nas requisições;
  • Company Id → utilizada como o password nas requisições;

Em cada requisição, inclua essas informações no cabeçalho HTTP, no campo Authorization, conforme o exemplo abaixo:

Exemplo em Node.js:

const options = {
    method: "POST",
    url: "https://api.huntersub.com.br/functions/v1/transactions",
    headers: {
        authorization:
            "Basic " + new Buffer("{SECRET_KEY}:{COMPANY_ID}").toString("base64"),
    },
};

Endpoints Base

A URL base da API é:

https://api.huntersub.com.br/functions/v1

Recursos Disponíveis

Nossa API oferece os seguintes recursos principais:

  • Transações: Gerenciamento completo de transações (criação, listagem, busca e atualização)
  • Clientes: Gerenciamento de clientes (criação, listagem, busca e atualização)

Para mais detalhes sobre cada endpoint, consulte a documentação completa da API.