Funcionamento da API (Integração ISS)
Objetivo:
Documentação das credenciais e informações para a API de integração do ISS, para conhecimento do time e fornecimento de informações a terceiros que desejam se integrar ao ISS.
Autenticação:
Esse tópico trata da autenticação no servidor de Login do ambiente Cebi, realizada através de chamadas HTTP.
Dessa forma, o Usuário de Integração Envia Credenciais, que passam pelo sistema Integrador (CEBI) - o qual valida as credenciais - e por sua vez retorna com o token (expirável) para que as informações de integração sejam validadas pela integração desejada (Boletos, Cadastro, Pagamento, Dívida Ativa).
Endpoints:
| URL | Método |
|---|---|
| http://agenciavirtual.cebicloud.com.br/login/connect/token | POST |
Headers:
Content-Type: application/x-www-form-urlencoded
| Campo | Conteúdo |
|---|---|
| grant_type | client_credentials |
| client_id | Será informado pela CEBI |
| client_secret | Será informado pela CEBI |
| scope | Cebi.Api |
Emissão de Boletos:
Uma vez com as credenciais obtidas/autenticadas, o boleto deverá ser enviado para recebimento/processamento:
Endpoints:
| URL | Método |
|---|---|
| http://agenciavirtual.cebicloud.com.br/integracao_iss/boletos | POST |
Conteúdo:
O Conteúdo deverá ser enviado no BODY da requisição como um objeto JSON, como nos campos descritos abaixo:
BOLETO CONTRIBUINTE CCM
Boletos emitidos para contribuintes do municipio (com CCM) deverão ser enviados dentro desta especificação, para criação do débito no nosso sistema.
| Nome | Tipo | Descrição |
|---|---|---|
| ChaveGuia | Numérico | Número do Boleto |
| ChaveGuiaOriginal | Numérico (OPCIONAL) | Utilizado para 2a via |
| TipoBoleto | Numérico | 1 - Avulso, 2 - Encerramento, 3 - SegundaVia, 4 - Complementar, *Boletos do tipo “Cancelamento” deverão ser enviados ao endpoint de cancelamentos. |
| TipoTributacao | Numérico | 0 - Tomado 1 - Prestado |
| Ccm | Alfa-Numérico | |
| CpfCnpj | Alfa-Numérico | 000.000.000-00 (CPF) // 00.000.000/0000-00 (CNPJ) |
| ExercicioBase | Numérico | |
| Mes | Numérico | |
| DataEmissao | Data | |
| DataVencimento | Data | |
| ValorImposto | Decimal | |
| ValorMulta | Decimal | |
| ValorJuros | Decimal | |
| ValorCorrecao | Decimal | |
| NossoNumero | Numérico | |
| CadastroEventual | Objeto | Obrigatório em boletos emitidos para contribuintes de fora do municipio |
CADASTRO EVENTUAL
Boletos emitidos para contribuintes de fora do municipio deverão, dentro do objeto do Boleto, ter um objeto chamado “Cadastro Eventual”, para criação no nosso sistema.
| Nome | Tipo | Descrição |
|---|---|---|
| Ccm | Numérico (OPCIONAL) | |
| CpfCnpj | Alfa-Numérico | 000.000.000-00 (CPF) // 00.000.000/0000-00 (CNPJ) |
| RazaoSocial | Alfa-Numérico | |
| NomeFantasia | Alfa-Numérico | |
| TipoLogradouro | Alfa-Numérico | |
| Logradouro | Alfa-Numérico | |
| Numero | Alfa-Numérico | |
| Bairro | Alfa-Numérico | |
| Cep | Alfa-Numérico | |
| Complemento | Alfa-Numérico | |
| Cidade | Alfa-Numérico | |
| Estado | Alfa-Numérico | |
| Telefone | Alfa-Numérico | |
| CodigoServico | Numérico (OPCIONAL) | |
| DataInicialServico | Data (Opcional) | |
| DataFinalServico | Data (Opcional) | |
| Regime | Alfa-Numérico |