PHSYS - Wiki

Conceito

O Cadastro de Autenticação de API é utilizado para definir as credenciais e parâmetros necessários para as integrações do sistema com serviços externos, por exemplo, APIs bancárias. Este cadastro é flexível e contempla diferentes modelos de autenticação, permitindo a utilização em ambientes de homologação e produção, conforme exigido pelo agente integrador.

• Identificação: Nome da autenticação, utilizado apenas para identificação e organização dos cadastros no sistema.
• Ambiente: Ambiente ao qual a autenticação está sendo vinculada.
  • Homologação
  • Produção
• Client ID: Identificador único fornecido pelo agente da integração para autenticar a aplicação cliente durante as requisições ao webservice.
• Client Secret: Chave secreta associada ao ClientID, utilizada para validar a autenticidade da aplicação nas comunicações das requisições.
• KeyUser: Chave ou identificador do usuário responsável pela integração.
• Integration Key: Chave de integração fornecida pelo agente integrador, utilizada para autenticação ou autorização das requisições, conforme o modelo adotado pela API.
• Arquivo CRT: Certificado digital no formato .crt, utilizado para estabelecer comunicação segura (SSL/TLS) entre a aplicação cliente e o webservice. Este arquivo contém a chave pública que garante a identidade do emissor.
• Arquivo KEY: Chave privada correspondente ao certificado digital informado em "Arquivo CRT". É utilizada em conjunto com o certificado para autenticação mútua e assinatura digital das requisições.
• Usuário que incluiu: Usuário responsável pelo cadastro da autenticação no sistema.
• Data / Hora inclusão: Data e hora em que o cadastro da autenticação foi realizado.

Conclusão

O Cadastro de Autenticação de API é essencial para garantir a comunicação segura e confiável entre o sistema e serviços externos. Ele centraliza as credenciais de acesso e permite a correta configuração das integrações, assegurando controle de ambientes, segurança das informações e conformidade com os requisitos técnicos dos provedores de API.