Documentação [Via App] (GESTÃO DE CONTAS)
Guia simples para configurar e usar no dia a dia.
Configuração de infraestrutura NGINX
Antes de iniciar a configuração da integração, é necessário abrir um chamado para a equipe de DevOps solicitando a configuração do Nginx da loja/ambiente onde a integração será utilizada. Essa configuração é indispensável para permitir a comunicação correta entre o ILLI e os serviços da Credsystem. Como referência para o escopo da solicitação, utilize o chamado SIC-14670, adaptando as informações conforme o ambiente e a loja que será configurada. Somente após a conclusão desse chamado prossiga com as etapas de configuração da integração.
Modelo do chamado: https://illimitar.atlassian.net/browse/SIC-14670
----------------------------------------------------------------------------------------------------------------------------------
1. Instalação dos Apps
Na IlliStore, precisamos instalar os 3 Apps e conferir se as bibliotecas abaixo foram importadas
981bfb94-afe7-4956-8ecd-4ecbc3b45246
88e14c87-331c-485b-95f8-8f63d76d446d
857e21c5-203f-4943-b60d-9258bf0ebd7e
f3d67c71-a1f9-4709-a81f-de0a4bb1f6e6
Apps:
@ISNP-337
@I-SNP-337M
@I-SNP-337MM
2. Configurar a integração
Na tela Configuração Credsystem, salve as credenciais da Credsystem por loja (API OAuth) em Configurações (Gerais).
/bibliotecas/981bfb94-afe7-4956-8ecd-4ecbc3b45246/api_integracao_credsystem
Passo a passo
- Escolha a Entidade (loja).
- Preencha o usuário e senha em Acesso da loja.
- Preencha Client ID, Client Secret e Scope em Credenciais OAuth.
- Confira as 3 URLs em URLs dos serviços (homologação ou produção).
- Preencha Bandeira e os IDs do ILLI em Parâmetros ILU.
- Clique em Salvar configuração.
O que cada campo significa
| Entidade |
Loja que está sendo configurada. |
|---|---|
| Usuário |
Usuário da loja |
| Senha |
Senha da loja |
| Client ID | Usuário técnico da API. |
| Client Secret | Senha técnica da API. |
| Scope | Permissão do token. |
| URL Base Arrecadação | Endereço para pagamentos e títulos. |
| URL Base Venda Loja | Endereço para limite e planos. |
| URL OAuth | Endereço para gerar o token. |
| Bandeira | Em geral OBJETIVA. |
| ID forma de pagamento | Código da forma Credsystem no ILLI. |
| ID natureza receita | Natureza do recebimento. |
| ID natureza despesa | Natureza do estorno/desfazimento. |
3. Configurar o totem (aparência)
Em Configurações (Totem) é possível ajustar tempos de uso e a aparência do totem Credsystem PIX (tela inicial e telas internas).
3.1 Configurações gerais do totem
Retorno por inatividade
Define por quanto tempo o totem aguarda sem toque ou tecla nas telas internas (CPF, pagamento e sucesso) antes de voltar automaticamente para a tela inicial.
- Campo: Tempo sem atividade (em segundos)
- Intervalo permitido: 1 a 3600 segundos
- Padrão: 30 segundos
- Clique em Salvar tempo para gravar
Revelação do CPF
Define por quanto tempo o CPF fica legível após o cliente tocar no ícone de olho na tela de digitação. Toque de novo no olho oculta de imediato.
- Campo: Tempo com CPF revelado (em segundos)
- Intervalo permitido: 1 a 60 segundos
- Padrão: 3 segundos
- Clique em Salvar tempo para gravar
3.2 Tela Principal
Configura a tela de atração (tela inicial) do totem: imagem de fundo, cor de fundo e indicador pulsante.
Imagem de fundo da tela inicial
Envie a imagem da tela de atração do totem. Sem arquivo, permanece o layout padrão. Com imagem, ela substitui fundo e textos iniciais.
- Formatos: JPG, PNG, WEBP ou GIF
- Tamanho máximo: 8 MB
- Tamanho recomendado: 970 px (largura) × 1705 px (altura)
- Use Escolher imagem para selecionar o arquivo e Enviar para salvar
- Use Remover imagem para voltar ao layout padrão / permitir cor de fundo
Cor de fundo da tela inicial
Escolha a cor de fundo quando não há imagem configurada. Se houver imagem de fundo selecionada, a cor fica indisponível — remova a imagem para poder definir a cor.
- Presets: Credsystem, Azul escuro, Verde, Vinho, Grafite e Personalizada
- A pré-visualização mostra como a tela inicial fica com a cor escolhida
- Clique em Salvar cor para gravar
Pulsar
Escolha a posição do indicador pulsante na grade 3×3 e personalize o texto exibido abaixo dele na tela inicial do totem.
- Exibir pulsar: liga ou desliga o indicador
- Texto do pulsar / Mensagem: até 60 caracteres (padrão: “Toque em qualquer lugar”)
- Posição na tela: grade 3×3 (ex.: Inferior centro)
- Clique em Salvar pulsar para gravar
3.3 Telas Internas
Configura o fundo das etapas após a tela inicial (CPF, pagamento e sucesso).
Imagem de fundo das telas internas
Envie a imagem de fundo das etapas internas. Sem arquivo, permanece o layout padrão (ou a cor escolhida abaixo).
- Formatos: JPG, PNG, WEBP ou GIF
- Tamanho máximo: 8 MB
- Tamanho recomendado: 970 px (largura) × 1705 px (altura)
- Use Escolher imagem e depois Enviar
Cor de fundo das telas internas
Escolha a cor de fundo quando não há imagem configurada nas telas internas. A cor é salva no servidor e aplicada após recarregar a página.
- Presets: Credsystem, Azul escuro, Verde, Vinho, Grafite e Personalizada
- A pré-visualização mostra um mockup das telas internas com a cor escolhida
- Clique em Salvar cor para gravar
4. Impressora no Gestor
Para o comprovante sair no caixa, configure a impressora do operador no Gestor.
| Tipo de impressora | Bluetooth, USB, Rede, GPOS, Clover… ou Nenhum. |
|---|---|
| Nome do dispositivo | Nome da impressora. |
| MAC (Bluetooth) | Endereço da impressora Bluetooth. |
| IP e Porta (Rede) | Usados no tipo Rede (porta comum: 9100). |
| Colunas | Largura do cupom (ex.: 48). |
Salve e faça um teste de impressão.
Credsystem × ILLI · Guia do usuário