Olá, cliente JACAD, tudo bem? Este guia traz todas as instruções necessárias para a utilização de api cadastro de perfil. Boa leitura!

ÍNDICE 

• 1. INTRODUÇÃO
• 2. AUTENTICAÇÃO
• 3. CADASTRO DE PERFIL
  • 3.1 Endpoint
  • 3.2 Campo Obrigatórios
• 4. CONFIGURAÇÕES DO CADASTRO DE PERFIL
• 5. TESTANDO A API COM POSTMAN
• 6. CONCLUSÃO

1. INTRODUÇÃO

API (Interface de Programação de Aplicações) é uma ferramenta que permite que diferentes sistemas "conversem" entre si. No nosso caso, a API do JACAD permite que você envie e receba dados entre seu sistema e a nossa plataforma, de forma segura e automatizada.

Por exemplo: você pode cadastrar perfis de usuários no seu sistema e esses dados serão automaticamente registrados também no JACAD.

2. AUTENTICAÇÃO

Antes de qualquer coisa, você precisa se autenticar na plataforma para usar a API. A autenticação é como uma "chave de entrada" para garantir que apenas usuários autorizados consigam fazer alterações.

O JACAD utiliza token na tela de "Cadastro de Tokens de Acesso".

Vá no menu "Integrações" navegue até "API de Integração" e clique em "Tokens de Acesso" e com isso acessar a tela de "Cadastro de Tokens de Acesso".

Figura 1

3. CADASTRO DE PERFIL

3.1 Endpoint

Para cadastrar um perfil, utilize a seguinte URL:

POST {{baseUrl}}/api/v1/basicos/perfis

Figura 2

3.2 Campo Obrigatórios

Você deve preencher pelo menos os seguintes campos:

• dataNascimento

• email

• idCliente

• idOrg

• nome

• sexo

Esses dados são o mínimo necessário para criar um novo perfil.

4. CONFIGURAÇÕES DO CADASTRO DE PERFIL

Na plataforma JACAD, há uma área onde você pode configurar quais campos da API são obrigatórios ou não. Para acessar:

Vá até o menu "Cadastro" e clique em "Perfil".

Figura 3

Dentro da tela de "Cadastro de Perfil" acesse a aba "Config" e clique em "Configurações do Cadastro de Perfil".

Figura 4

Figura 5

Ali você verá algumas flags que determinam se certos campos devem ser obrigatórios. Por exemplo, se marcar a opção “Validar o CPF”, o sistema vai exigir que o CPF seja informado na hora do cadastro do Perfil no desktop ou na API.

5. TESTANDO A API COM POSTMAN

Figura 6

Você pode usar o software Postman para testar suas requisições.

Se a flag “Validar o CPF” estiver ativada, e você não enviar esse campo, a API retornará um erro.

Figura 7

Figura 8

Para corrigir isso, basta incluir um CPF válido no corpo da requisição.

Figura 9

Sempre confira as configurações antes de enviar a API.

Figura 10

6. CONCLUSÃO

Chegamos ao final deste guia sobre a Api de Cadastro de Perfil no sistema JACAD! Esperamos que este material tenha sido útil para auxiliá-lo na configuração dessa funcionalidade. Em caso de dúvidas ou necessidade de suporte, fique à vontade para consultar nossa base de conhecimento ou entrar em contato com nossa equipe de suporte técnico.

 Agradecemos por confiar no JACAD e desejamos muito sucesso na gestão da sua instituição.

Até breve!