A aba de integração do iBPMS permite que sejam feitas as configurações necessárias para realizar as integrações via API do IBMPS com outros sistemas.
Para chegar na aba de integração você deve seguir os seguintes passos:
- No iBPMS, clique no menu “Configurações”, localizado a esquerda;
A aba “Configurações” está disponível apenas para usuários do tipo administrador do S-Sign.
- Em configurações, clique na aba “Integração”, localizada ao lado da aba “Papéis”.
Funcionalidades da aba de Integração:
- Gerar chave de acesso;
- informações da chave gerada;
- URL de callback;
- Endereço de webservice;
- Visualizar documentação.
1. Gerar chave de acesso
A chave de acesso é um código exclusivo que identifica um aplicativo ou usuário, sendo usada para autenticar e autorizar solicitações de API. Para gerar uma chave de acesso, basta você seguir os seguintes passos:
- Na aba Integração, clique no botão “Gerar chave de acesso”
- Ao clicar no botão, irá aparecer um circulo de carregamento ao lado
- Após o carregamento irá aparecer uma mensagem “Chave de acesso gerada com sucesso” indicando o sucesso em gerar sua chave.
- A chave gerada será mostrada logo abaixo em um campo destinado á ela.
Após a primeira vez que é gerada uma chave de acesso, ficará um alerta, indicando que quando for gerada uma nova chave, aquela que foi gerada anteriormente irá expirar e somente a nova será valida.
2. Informações da chave gerada
Logo abaixo do alerta, ficarão as informações da chave gerada. Neste espaço você consegue identificar qual foi o usuário e qual foi a data que este usuário gerou a chave. Há também um botão no final do campo, para que você possa clicar e copiar toda a chave de acesso. A chave que será exibida será sempre a que foi gerada pela ultima vez.
3. URL de callback
Uma URL de callback é um endereço usado para que o S-Sign avise automaticamente outro sistema quando uma ação foi concluída com sucesso.
4. Endereço de webservice
O Endereço de webservice é como um caminho digital que os sistemas utilizam para solicitar e receber informações de forma automática. Sua principal função é tornar dados ou funcionalidades acessíveis a outras aplicações.
5. Visualizar documentação
Este é um botão que irá redirecionar você para o Swagger, onde ficará disponível as documentações e onde será possível fazer a autenticação para utilização da API. Saiba mais clicando aqui.
