Pular para conteúdo

Uso da API - Guia para Integradores

Este guia explica como usar a API do ecosif-masterdata.

Autenticação

Todos os endpoints protegidos requerem autenticação via token JWT no header:

Authorization: Bearer <seu-token-jwt>

Veja Autenticação para obter um token.

Endpoints Disponíveis

Empresas

  • POST /company: Criar empresa
  • GET /companies: Listar empresas
  • GET /companies/{id}: Obter empresa por ID
  • PUT /companies/{id}: Atualizar empresa
  • DELETE /companies/{id}: Excluir empresa

Filiais

  • POST /branch: Criar filial
  • GET /allbranch/{company}: Listar filiais de uma empresa
  • GET /branch/{id}: Obter filial por ID

Plano de Contas

  • POST /chartOfAccounts: Criar conta
  • GET /chartOfAccounts/getallcoa/{company}/{branch}: Listar todas as contas
  • GET /chartOfAccounts/{id}: Obter conta por ID

Veja Lista Completa de Endpoints para todos os endpoints.

Formato de Requisições

Content-Type

Todas as requisições POST/PUT devem usar:

Content-Type: application/json

Formato de Respostas

Sucesso (200/201 OK)

{
  "id": 1,
  "name": "Minha Empresa",
  "cnpj": "12345678000190"
}

Erro (400/401/404/500)

{
  "success": false,
  "message": "Mensagem de erro descritiva"
}

Códigos de Status HTTP

Código Significado
200 OK
201 Created
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
406 Not Acceptable
409 Conflict
500 Internal Server Error

Próximos Passos