← Voltar para a página inicial

Documentação da API

Documentação completa de todos os endpoints públicos da API REST do Lunaris Nexus

Documentação

Endpoints públicos da API

Autenticação

Todas as requisições devem incluir o header de autenticação. Para obter uma chave de API, você precisa estar logado e acessar a página de configurações de API.

Authorization: Bearer ln_sua_chave_api_aqui

Base URL

https://www.lunarisnexus.com.br/api

Endpoints da API

GET/clients

Listar todos os clientes

Retorna uma lista de todos os clientes cadastrados no sistema

Requisição:

curl -X GET "https://www.lunarisnexus.com.br/api/clients" \
  -H "Authorization: Bearer ln_sua_chave_api_aqui"

Resposta:

[
  {
    "id": "cmiaaai9o0000108fk38bnz0u",
    "name": "Empresa Exemplo Ltda",
    "document": "12345678000190",
    "email": "contato@empresaexemplo.com.br",
    "type": "COMPANY",
    "contact": {
      "phone": "(11) 98765-4321"
    },
    "createdAt": "2024-01-01T00:00:00.000Z"
  }
]
POST/clients

Criar novo cliente

Cria um novo cliente no sistema

Requisição:

curl -X POST "https://www.lunarisnexus.com.br/api/clients" \
  -H "Authorization: Bearer ln_sua_chave_api_aqui" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Nova Empresa",
  "document": "98765432000100",
  "email": "contato@novaempresa.com.br",
  "type": "COMPANY",
  "contact": {
    "phone": "(11) 12345-6789"
  }
}'

Resposta:

{
  "id": "cmiaaai9o0000108fk38bnz1v",
  "name": "Nova Empresa",
  "document": "98765432000100",
  "email": "contato@novaempresa.com.br",
  "type": "COMPANY",
  "contact": {
    "phone": "(11) 12345-6789"
  },
  "createdAt": "2024-01-01T00:00:00.000Z"
}
GET/clients/:id

Obter cliente por ID

Retorna os dados de um cliente específico

Parâmetros:

  • id* (string) - ID do cliente

Requisição:

curl -X GET "https://www.lunarisnexus.com.br/api/clients/:id" \
  -H "Authorization: Bearer ln_sua_chave_api_aqui"

Resposta:

{
  "id": "cmiaaai9o0000108fk38bnz0u",
  "name": "Empresa Exemplo Ltda",
  "document": "12345678000190",
  "email": "contato@empresaexemplo.com.br",
  "type": "COMPANY",
  "contact": {
    "phone": "(11) 98765-4321"
  },
  "createdAt": "2024-01-01T00:00:00.000Z"
}
PATCH/clients/:id

Atualizar cliente

Atualiza os dados de um cliente existente

Parâmetros:

  • id* (string) - ID do cliente

Requisição:

curl -X PATCH "https://www.lunarisnexus.com.br/api/clients/:id" \
  -H "Authorization: Bearer ln_sua_chave_api_aqui" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Empresa Atualizada",
  "email": "novo@email.com.br"
}'

Resposta:

{
  "id": "cmiaaai9o0000108fk38bnz0u",
  "name": "Empresa Atualizada",
  "email": "novo@email.com.br"
}
DELETE/clients/:id

Excluir cliente

Remove um cliente do sistema

Parâmetros:

  • id* (string) - ID do cliente

Requisição:

curl -X DELETE "https://www.lunarisnexus.com.br/api/clients/:id" \
  -H "Authorization: Bearer ln_sua_chave_api_aqui"

Resposta:

{
  "message": "Cliente excluído com sucesso"
}

Documentação Interativa

Acesse o Swagger UI

Abrir Swagger UI