Pular para o conteúdo principal

Informações gerais

Endereços​

Serviços disponibilizados​

As mutations disponibilizadas para gerenciamento de cadastros de beneficiários/colaboradores irão efetuar a validação de preenchimento das informações obrigatórias, tipos, formatos e tamanhos dos parâmetros da requisição e depositarão as instruções recebidas em uma fila para processamento, retornando o Id da instrução nesta fila.

Para obter o resultado final do processamento da instrução enviada, são disponibilizadas duas formas:

  • através de uma chamada de notificação ( webhook ), efetuada imediatamente ao final do processamento da instrução, para um endpoint https do sistema do cliente previamente configurado na Funcional, vinculado ao CNPJ do cliente

  • através de requisições posteriores à query getProcessingStatus fornecendo o Id que foi obtido na resposta do envio da instrução a mutation.

Gateway

Fluxo da integração​

Passo 1: Criação do token​

Para efetuar qualquer requisição é preciso enviar também o token de autenticação, para obtê-lo utilize a mutation createToken.

Caso tenha dúvidas, acesse aqui para ver o passo a passo de criação e utilização do token nas requisições.

Dica

O mesmo token pode ser utilizado em várias requisições até atingir seu tempo de expiração. Fazendo isso, você terá uma melhor performance na integração do seu sistema com a Funcional.

Passo 2: Envio de instruções​

Efetuar o envio das instruções de movimentação.

Atenção

Somente enviar instruções de inclusão de dependentes após ter enviado a instrução do titular ou caso o titular já esteja previamente cadastrado em nosso sistema.

Dependendo da necessidade, o cliente pode optar por utilizar as mutations:

Ou as mutations:

Dica

Para ver a referência completa da API clique aqui.

Passo 3: Status do processamento​

Conforme descrito acima, o cliente pode optar por efetuar requisições posteriores a query getProcessingStatus para verificar o status do processamento da instrução ou receber as notificações via webhook imediatamente após o final de seu processamento.

Na próxima página serão fornecidas informações mais detalhadas sobre como receber as notificações via webhook.