• Ocorrência (ou instrução bancária): é uma orientação que a sua empresa envia ao banco sobre um título de cobrança. Os exemplos mais comuns são Protestar (encaminhar o título a protesto) e Não Protestar (cancelar ou não realizar o protesto).
   
• Modalidade de pagamento: é o tipo de pagamento que um canal de pagamento é capaz de realizar (por exemplo, pagamento de fornecedores, tributos, entre outros).
   
• API (canal de integração): é a forma como o Sistema SINGE conversa diretamente com o banco pela internet, sem a necessidade de gerar e enviar arquivos manualmente. Cada API representa um canal, ligado a um banco e a uma finalidade.
   
• Tipo da API: indica a finalidade do canal. Pode ser Cobrança (para enviar instruções sobre títulos, como o protesto) ou Pagamento (para enviar pagamentos).
   
• Certificado digital: é um arquivo de segurança que comprova a identidade da sua empresa junto ao banco. Sem ele, a comunicação não é autorizada.
   
• Credenciais: são as informações de acesso fornecidas pelo banco para liberar a comunicação com o canal. Costumam ser preenchidas com o apoio da equipe técnica.
   
• Convênio / Contrato: é o número que alguns bancos exigem para identificar o acordo da sua empresa com aquele canal.
   
• DDA (Débito Direto Autorizado): é o serviço pelo qual a sua empresa recebe, de forma eletrônica, os boletos emitidos contra ela.
   
• PagFor: é um padrão bancário (da Febraban) utilizado para o envio de pagamentos.

• Você precisa ter permissão de acesso à esta tela, concedida conforme as regras de segurança da sua empresa.
   
• Os bancos com os quais a sua empresa trabalha já devem estar cadastrados no sistema, pois eles são selecionados em vários momentos desta tela.
   
• Os certificados digitais e as credenciais de acesso, quando exigidos pelo banco, devem estar disponíveis. Esses itens normalmente são obtidos junto ao banco e configurados com o apoio da equipe técnica.
   
• Recomenda-se conhecer, antes do cadastro, qual é a finalidade de cada canal (Cobrança ou Pagamento) e quais instruções (ocorrências) ou modalidades ele deverá atender.

• Configurações: define comportamentos gerais da sua empresa, como a aprovação automática de instruções, o uso de PagFor e o banco utilizado para a varredura de DDA.
   
• APIs por Empresa: lista e gerencia os canais (APIs) que a sua empresa efetivamente utiliza, com as respectivas senhas, convênios, certificados e credenciais.
   
• Gerenciar API: é o catálogo de todos os canais (APIs) disponíveis no sistema. Aqui você cadastra, altera e exclui os canais e define quais instruções ou modalidades cada um atende.
   
• Ocorrências: é o cadastro das instruções bancárias por banco, como Protestar e Não Protestar.
   
• Modalidades: é o cadastro das modalidades de pagamento utilizadas pelos canais de pagamento.

• Aprovação de instrução bancária automática?
  Quando marcada, as instruções enviadas aos bancos (por exemplo, os protestos) são aprovadas automaticamente, sem uma etapa de aprovação manual. Quando desmarcada, será necessária uma aprovação antes do envio. Avalie a política da sua empresa antes de ativar essa opção, pois ela agiliza a operação, mas dispensa a conferência manual.
   
• Utiliza PagFor?
  Marque esta opção se a sua empresa utiliza o padrão PagFor para os pagamentos. Essa escolha influencia a forma como os pagamentos são preparados nas rotinas de Contas a Pagar.
   
• Banco para Varredura DDA.
  Selecione, na lista, o banco que será utilizado para buscar os boletos emitidos contra a sua empresa (DDA). Caso você tente gravar sem escolher um banco, o sistema exibirá a mensagem “Selecione um banco para varredura DDA”.

• Acesse a aba Ocorrências.
• No campo Banco, selecione o banco desejado. A lista abaixo será preenchida com as ocorrências já cadastradas para esse banco, exibindo as colunas Código, Nome e a opção Excluir.

• Com o banco já selecionado, clique em Adicionar.
• Na janela que se abre, informe o Código (numérico, com até dois dígitos) e o Nome da ocorrência (por exemplo, “Protestar”).
• Clique em Adicionar para gravar.

• Na linha da ocorrência desejada, clique no ícone Excluir (lixeira). Tenha atenção: excluir uma ocorrência que já esteja em uso pode afetar o envio de instruções ao banco.

• Ao acessar a aba Modalidades, a lista exibe todas as modalidades já cadastradas, com as colunas Código, Nome e a opção Excluir.

• Clique em Adicionar.
• Informe o Código e o Nome da modalidade.
• Clique em Adicionar para gravar.

• Clique em Adicionar: A janela de cadastro será aberta.
• Banco: selecione o banco do canal.
• Título API: informe um nome claro que identifique o canal (por exemplo, “API Instrução Itaú”).
• URL Base: informe o endereço de comunicação fornecido pelo banco ou pela equipe técnica.
• Exige código de convênio? marque esta opção se o banco exigir um número de convênio ou contrato para o canal.
• API de baixa? marque esta opção se o canal for utilizado para dar baixa em títulos.
• Tipo de API: escolha entre Pagamento e Cobrança. Se escolher Pagamento, será exibida a lista Modalidades de pagamento; marque as modalidades que o canal atende. Se escolher Cobrança, será exibida a lista Ocorrências de cobrança, com as instruções cadastradas para o banco selecionado; marque as instruções que o canal deve atender.

• Na linha do canal desejado, clique no ícone Alterar.
• Na janela, você pode ajustar o Título API, a URL Base, as opções Exige código de convênio? e API de baixa?, além de marcar ou desmarcar as modalidades ou as ocorrências atendidas.
• Clique em Salvar para confirmar as alterações do canal.

• Clique em Adicionar.
• No campo API, selecione o canal desejado. Os canais disponíveis são aqueles cadastrados na aba Gerenciar API.
• Informe a Senha certificado (a senha do certificado digital utilizado na comunicação).
• Se o canal exigir, informe o Convênio/Contrato. Esse campo é solicitado apenas quando o canal está marcado como “Exige código de convênio?”.
• Clique em Adicionar para gravar o vínculo.

• Cadastre as instruções do banco na aba Ocorrências (para canais de Cobrança) e/ou as modalidades na aba Modalidades (para canais de Pagamento).
   
• Cadastre o canal na aba Gerenciar API, informando banco, título, URL Base e tipo, e marcando as instruções ou modalidades que ele atende.
   
• Vincule o canal à sua empresa na aba APIs por Empresa, informando a senha do certificado, o convênio/contrato (se exigido), anexando os certificados e preenchendo as credenciais.
   
• Ajuste, na aba Configurações, os parâmetros gerais da empresa (aprovação automática, PagFor e banco de DDA), conforme a necessidade.

• Cobrança e instruções (Protestar / Não Protestar).
  As ocorrências que você habilita determinam quais instruções a sua empresa pode enviar ao banco a respeito dos títulos de cobrança. Quando a instrução de protesto está habilitada e é enviada, o título poderá ser encaminhado a protesto pelo banco, o que tem efeito direto sobre o cliente final que deve aquele valor. Por isso, a habilitação de “Protestar” e “Não Protestar” deve refletir a política de cobrança da empresa. Essas definições são utilizadas pelas rotinas de Contas a Receber e Cobrança.
   
• Aprovação automática de instruções.
  Quando ativada, as instruções seguem para o banco sem uma etapa de aprovação manual; quando desativada, alguém precisa aprová-las antes do envio. Trata-se de um ponto de controle: agiliza a operação, mas reduz a conferência manual.
   
• Pagamentos e modalidades.
  As modalidades habilitadas em um canal de Pagamento determinam quais tipos de pagamento a fornecedores podem ser enviados por aquele canal. O parâmetro “Utiliza PagFor?” influencia a forma como os pagamentos são preparados e enviados nas rotinas de Contas a Pagar.
   
• Varredura de DDA.
  O banco escolhido define de onde serão buscados os boletos emitidos contra a sua empresa, afetando a rotina que importa e consulta esses boletos.
   
• Certificados e credenciais.
  São as chaves que autenticam a empresa junto ao banco. Sem o certificado correto e as credenciais válidas, a comunicação com o banco não funciona, ainda que todo o restante esteja cadastrado. Por serem informações sensíveis, devem ser tratadas com sigilo e cadastradas com o apoio da equipe técnica.

• Informações compartilhadas (catálogo).
  O catálogo de canais (aba Gerenciar API), de ocorrências (aba Ocorrências) e de modalidades (aba Modalidades) tem caráter estrutural e pode ser utilizado por mais de uma empresa que trabalhe com o mesmo banco e o mesmo canal.
   
• Informações individuais (por empresa).
  Os vínculos por empresa (aba APIs por Empresa), os certificados, as credenciais e os parâmetros (aba Configurações) são exclusivos de cada empresa.
   
• Cuidado ao alterar ou excluir.
  Como o catálogo pode ser compartilhado, alterar ou excluir um item pode impactar todas as empresas que o utilizam. É justamente por isso que o sistema impede a exclusão de uma API que ainda esteja vinculada a alguma empresa. Recomenda-se cautela e alinhamento prévio com as áreas envolvidas antes de modificar canais, ocorrências ou modalidades já em uso.

• Por que não consigo excluir uma API?
  Porque ela ainda está vinculada a pelo menos uma empresa. Remova o vínculo na aba APIs por Empresa, em todas as empresas, e depois exclua o canal na aba Gerenciar API.
   
• Onde marco “Protestar” e “Não Protestar”?
  Essas instruções são ocorrências de cobrança. Primeiro, elas precisam estar cadastradas para o banco na aba Ocorrências. Depois, ao cadastrar ou alterar a API de Cobrança daquele banco (aba Gerenciar API), elas aparecem na lista “Ocorrências de cobrança”; basta marcar as caixas para vincular e desmarcar para desvincular.
   
• O campo Convênio/Contrato não aparece ou está bloqueado. Por quê?
  Esse campo só é exigido quando o canal está marcado como “Exige código de convênio?”. Se o canal não exige, o campo permanece desabilitado; se exige e está em branco, o sistema solicitará o preenchimento.
   
• Cadastrei tudo, mas a comunicação com o banco falha. O que verificar?
  Confira se o certificado digital foi anexado (ícone Certificados) e se as credenciais (JSON) estão preenchidas e corretas. Esses itens são fornecidos e configurados com o apoio da equipe técnica. Se o problema persistir, acione o suporte.
   
• Cliquei e a tela ficou “Processando”. O que faço?
  O sistema está concluindo a operação. Aguarde; não clique repetidamente nem feche a janela, para evitar duplicidade de registros.
   
• Posso alterar o nome de uma API depois de criada?
  Sim, pela opção Alterar na aba Gerenciar API (título e URL Base, entre outros campos). Lembre-se de que a alteração vale para todas as empresas que utilizam o canal.