03. 🏢 Gestão de Clientes (Parceiros)

Gestão de clientes para parceiros ⚠️ IMPORTANTE: Endpoints exclusivos para PARCEIROS gerenciarem seus clientes/emissores. Requer autenticação via Application-Token. Controle administrativo de empresas clientes vinculadas ao parceiro. Funcionalidades:

• Listar empresas/emissores do parceiro

• Ativar cadastro de cliente

• Inativar cadastro de cliente Nota: Para cadastro de clientes comerciais, fornecedores e transportadoras da empresa, veja a seção "04. 👥 Clientes, Fornecedores e Transportadoras".

Ativar cadastro de empresa

post

Ativar uma empresa já cadastrada

Endpoint utilizado para um parceiro ativar uma empresa já cadastrada no sistema. A empresa será marcada como ativa e poderá utilizar todas as funcionalidades da plataforma.

Pré-requisitos:

• Empresa deve estar previamente cadastrada

• Parceiro deve ter permissão sobre a empresa

• Autenticação via Application-Token

Casos de uso:

• Reativar empresa temporariamente suspensa

• Ativar empresa após cadastro inicial

• Restaurar acesso de cliente

Autorizações

Bearer

AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Parâmetros de cabeçalho

Application-TokenstringOpcional

Token de autenticação do parceiro. Esta chave deve ser solicitada à Maino.

Respostas

200

Cliente ativado com sucesso

application/json

messagestringOpcional

Mensagem de confirmação da ativação

Example: Cliente ativado com sucesso

400

Erro de validação

application/json

401

Cliente não pertence ao parceiro

application/json

post

/ativacao_cadastros

HTTPcURLJavaScriptPython

POST /api/v2/ativacao_cadastros HTTP/1.1
Host: api.maino.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Cliente ativado com sucesso"
}

Inativar cadastro de empresa

delete

Inativar uma empresa cadastrada

Endpoint utilizado para um parceiro inativar uma empresa já cadastrada no sistema. A empresa será marcada como inativa e terá seu acesso suspenso às funcionalidades da plataforma.

Pré-requisitos:

• Empresa deve estar ativa

• Parceiro deve ter permissão sobre a empresa

• Autenticação via Application-Token

Casos de uso:

• Suspender temporariamente acesso de cliente

• Inativar empresa por inadimplência

• Suspender por questões contratuais

Autorizações

Bearer

AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Parâmetros de cabeçalho

Application-TokenstringOpcional

Token de autenticação do parceiro. Esta chave deve ser solicitada à Maino.

Respostas

200

Cliente inativado com sucesso

application/json

messagestringOpcional

Mensagem de confirmação da inativação

Example: Cliente inativado com sucesso

400

Erro de validação

application/json

401

Cliente não pertence ao parceiro

application/json

delete

/ativacao_cadastros

HTTPcURLJavaScriptPython

DELETE /api/v2/ativacao_cadastros HTTP/1.1
Host: api.maino.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Cliente inativado com sucesso"
}

Lista empresas do parceiro

get

Lista empresas/emissores do parceiro autenticado

Retorna lista de empresas (emissores) vinculadas ao parceiro.

Pré-requisitos:

• Autenticação via Application-Token

• Parceiro deve ter empresas vinculadas

Autorizações

ApiKey

Parâmetros de cabeçalho

Application-TokenstringOpcional

Token de autenticação do parceiro

Respostas

200

Lista de empresas retornada com sucesso

application/json

401

Parceiro inválido

application/json

get

/empresas

HTTPcURLJavaScriptPython

GET /api/v2/empresas HTTP/1.1
Host: api.maino.com.br
Accept: */*

{
  "empresas": [
    {
      "ativo": true,
      "cnpj": "12345678000190",
      "nome_fantasia": "Empresa Teste",
      "razao_social": "Empresa Teste LTDA",
      "inscricao_estadual": "123456789",
      "tipo_de_estabelecimento": 1,
      "cep": "80530080",
      "logradouro": "Rua das Empresas",
      "numero": "100",
      "complemento": "Sala 10",
      "bairro": "Centro",
      "uf_codigo": "SP",
      "municipio_codigo_ibge": 3550308,
      "ddd": "11",
      "telefone": "987654321",
      "email": "[email protected]",
      "modalidade_codigo": 2,
      "contribuinte_icms": true,
      "percentual_de_aproveitamento_de_icms": 0,
      "csosn": "103",
      "contribuinte_difal": false
    }
  ]
}