Pular para o conteúdo principal

Quick Start

Vá do zero à primeira chamada autenticada em menos de 10 minutos.

Passo 1 — Obtenha suas credenciais​

A Merx utiliza autenticação via API key gerenciada pelo gateway Kong. Para obter suas credenciais de sandbox, envie um e-mail para support-api@merx.tech com:

  • Assunto: Chave de Integração - Sandbox
  • Corpo: Informe o nome da empresa, nome do responsável técnico e o objetivo da integração.

É obrigatório utilizar o e-mail corporativo da empresa solicitante.

Você receberá:

  • Authorization — chave de autenticação validada pelo gateway
Tempo de resposta

A equipe responde em até 1 dia útil para ambientes de sandbox.

Passo 2 — Faça sua primeira chamada​

Com suas credenciais em mãos, execute o comando abaixo no terminal para listar os produtores da sua cooperativa:

curl -X GET \
  https://api.merx.tech/api/v1/integration/producers \
  -H "Authorization: {SUA_API_KEY}" \

Substitua {SUA_API_KEY} pelo valor recebido no e-mail.

Header obrigatório em toda requisição:

HeaderDescrição
AuthorizationSua chave de API (validada pelo Kong gateway)

Passo 3 — Interprete a resposta​

Uma chamada bem-sucedida retorna HTTP 200 com um array JSON de produtores. Exemplo de response:

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "company_name": "Agro Exemplo Ltda",
    "trading_name": "Agro Exemplo",
    "social_identity": "12345678000190",
    "email": "contato@agroexemplo.com.br",
    "date_of_birth": "1980-01-15",
    "rg": null,
    "marital_status": null,
    "address": {
      "street": "Rua das Palmeiras",
      "number": "100",
      "complement": null,
      "neighborhood": "Centro",
      "zip_code": "14400000",
      "city": "Franca",
      "state": "SP",
      "country": "Brasil"
    },
    "dap_code": null,
    "caf_code": null,
    "ricaf_code": null,
    "enabled": true,
    "removed": false,
    "created_at": 1713100800000,
    "updated_at": 1713100800000
  }
]
Campos de data

created_at e updated_at são timestamps em milissegundos desde o epoch Unix. date_of_birth usa formato ISO 8601 (yyyy-MM-dd).

Respostas de erro:

CódigoCausaBody
401Authorization inválida ou ausentesem body (resposta do Kong)
404Nenhum produtor cadastrado{"messages": ["message.producer.not-found"]}

Próximos passos​