-
Notifications
You must be signed in to change notification settings - Fork 0
Login
Endpoints usados para efetuar login por um segurado
Retorna as informações de contato de uma pessoa, os emails e telefones, censurados
-
Enviar uma requisição para este-endpoint utilizando o valor do campo "response-token" do payload para verificar se o captcha é válido;
- Caso contrário, retornar status code 401;
-
Verificar se existe na tabela "pf_cpf" um documento com a chave "pf_cpf" equivalente ao "cpf" presente no payload desta requisição.
- Caso não exista, retornar status code 404;
-
Consultar se a data de nascimento do cadastro retornado no item anterior é equivalente a informada no payload;
- Caso contrário, retornar status code 403;
-
Consultar neste endpoint as matrículas do usuário no órgão informado no payload.
- Caso tenha matrícula de ativo ou pensionista, seguir para o próximo passo.
- Caso tenha informado um instituidor, retornar status code 405.
- Caso tenha informado um usuário sem matriculas, retornar status code 412.
-
Retornar todos os emails e telefones cadastrados para o usuário, filtrando pelo oid informado no payload:
- Caso o usuário não possua emails e telefones, retornar 417;
Header:
Authorization: Bearer {JWT} //token de aplicação
Body:
{
"cpf": "123.456.789.10",
"nascimento": "2000-12-31",
"oid": "{oid}",
"oeid": "{oeid}",
"response-token": "{re-captch-response-token}"
}Resposta:
{
"success": true,
"data": {
"SocialAPI": {
"pf_id": "{snow_flake}",
"emails": [
{
"email": "***dre@bracon***",
"email_id": "{snow_flake}"
}
],
"cellphones": [
{
"cellphones": "081*****7151",
"cellphones_id": "{snow_flake}"
}
]
}
}
}200 | 400 | 401 | 403 | 404 | 405 | 412 | 417
Envia para o email o código para acessar a aplicação
-
Verificar se existe um usuário com o pf_id informado
*Caso não encontrado, retornar status code 404;
-
Verificar se o email_id informado é referente a um email referente ao pf_id
- Caso contrário, retornar status code 405;
-
Adicionar na collection Verification Code um novo documento com as informações do email e código gerado;
-
Enviar para o email o código de acesso a aplicação;
Header:
Authorization: Bearer {JWT} //Token aplicação
Body:
{
"pf_id": "{snow_flake}",
"email_id": "{snow_flake}"
}Resposta:
200 | 404 | 405
Envia para o celular o código para acessar a aplicação
-
Verificar se existe um usuário com o pf_id informado
*Caso não encontrado, retornar status code 404;
-
Verificar se o phone_id informado é referente a um celular referente ao pf_id
- Caso contrário, retornar status code 405;
-
Adicionar na collection Verification Code um novo documento com as informações do celular e código gerado;
-
Enviar para o celular o código de acesso a aplicação;
Header:
Authorization: Bearer {JWT} //Token aplicação
Body:
{
"pf_id": "{snow_flake}",
"cellphone_id": "{snow_flake}"
}Resposta:
200 | 404 | 405
Retorna o token do usuário, com o campo superUsuario="U", indicando login de usuário segurado e status="limited", token limitado
-
Verificar se existe na collection Verification Code um documento com o pf_id e o resource_id referente ao informado no payload.
*Caso não encontrado, retornar status code 404;
-
Verificar se o código informado no payload está de acordo com o código encontrado no item anterior;
*Caso contrário, retornar status code 405;
-
Verificar se o código informado no payload não foi expirado;
*Caso contrário, retornar status code 412;
-
Verificar se o código informado no payload já foi validado anteriormente;
*Caso verdade, retornar status code 409;
-
Verificar se na RH existe ao menos um registro de matrícula(servidor_id) vinculado ao pf_id retornado no item anterior;
- Caso contrário, retornar status code 406;
-
Adicionar na collection Verification Code o atributo "used" com a hora de acesso deste endpoint;
-
Consultar neste endpoint as matrículas do usuário no órgão informado no payload.
- Caso tenha matrícula de ativo ou pensionista, seguir para o próximo passo.
- Caso tenha informado um pensionario ou não exista matrícula para o usuário, retornar status code 417.
-
Retornar token de usuário com validade de 15 minutos e status="limited"
Header:
Authorization: Bearer {JWT} //token de aplicação
Body:
{
"pf_id": "{snow_flake}",
"code": "123456",
"resource_id": "{snow_flake}" // email_id ou cellphone_id
"oid": "{oid}",
"oeid": "{oeid}"
}Resposta:
{
"success": true,
"data": {
"SocialAPI": {
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NjUxODg1OTEsImlzcyI6Ik9ueXhwcmV2IiwiZXhwIjoxNTY1MjMxNzkxLCJuYmYiOjE1NjUxODg1OTAsImRhdGEiOnsiYXBwIjp7ImFwaUlkIjoiMjJlNmVjYjVhZGFhIiwiYXBwQ29kIjozMiwiYXBwT3NDb2QiOjEsIm5hbWUiOiJGb3BhZyIsImFwaWtleSI6IjIyZTZlY2I1YWRhYSIsInNlY3VyaXR5IjoiSSIsImxhdW5jaGVySWdub3JlIjoiTiIsImNhY2hlIjoiSSIsInZlcnNpb24iOiIxLjAuMCJ9LCJ1c2VyIjp7InBmQ29kIjo5OTksInVzdWFyaW9Db2QiOjI1Niwib3JnYW9Db2QiOjEsIm9yZ2FvRW50aWRhZGVDb2QiOjEsInByaXZDb2QiOjE1LCJzdXBlclVzdWFyaW8iOiJTIiwibm9tZSI6IkFORFJFIFBFUkVJUkEgTEVJVEUiLCJ1dWlkIjoiZDQ2MTIwZDRlMTk1ZjJjNWE3ZGFkN2JkYjhmYTYwIiwibG9naW4iOiIwNDYyMTQ2NTM3NiIsImZvdG8iOiJodHRwczpcL1wvc3RvcmFnZS1hbHBoYTIub255eGVycC5jb20uYnJcLzJmNGJjZGJlM2I3Yjg3NzZkZjU5NDUxZmEzNDk1Yi5wbmciLCJjZWx1bGFyIjpudWxsLCJlbWFpbCI6bnVsbCwidXNlci1sZW5ndGgiOjgsInBmaWQiOiI1MDE0OTA4NjE3ODc2NjgwNzU1Iiwib2lkIjoiNTA4YjM4NjdmOTFmYTBlMzNjYmI1ODkyYjY0NDNjIiwib2VpZCI6IjYxNTNlYWM5MGQzOTI3ZjVmYWE5MWViYzM2YWRiOCIsImZ1c29Ib3JhcmlvIjoiLTMiLCJtb2VkYSI6ImJyYXppbGlhbl9yZWFsIiwiaWRpb21hIjoicHQtYnIiLCJkYXRhIjoiYnJhemlsaWFuX2RhdGVfZm9ybWF0IiwibGF1bmNoZXIiOiJfYmxhbmsifX19.yu1p6e-rdaQSejprBNjRiv8a-5P8Ko3acIGMefxjbbM"
}
}
}200 | 400 | 401 | 403 | 404 | 405 | 409 | 412 | 417
Repositório: https://github.com/BRAConsultoria/SocialAPI-v2/
- Obtendo imagens por tipo de documento
- Obtendo tipos de documentos vinculados à uma imagem
- Vinculando e desvinculando imagem a tipos de documentos
- Obtendo a classificação de um documento
- Manipulando endereços de forma autônoma
- Inserindo uma pessoa [v1] [v2] [v3]
- Obtendo o perfil de uma pessoa
- Obter atualizações mais recentes
- Obter consulta na RFB
- Alterando o perfil de uma pessoa
- Retornando informações de contato
- Enviando código para o email
- Enviando código para o celular
- Efetuando Login
- Perguntas do Challenge
- Respondendo ao Challenge
-
Manipulando a CTPS
-
Contratos de uma CTPS
-
Manipulando a CTC
-
Contratos de uma CTC
- Obtendo carteira de classe
- Inserindo carteira de classe
- Alterando carteira de classe
- Removendo carteira de classe
- Obtendo os telefones
- Inserindo um telefone
- Removendo um telefone
- Requisitando código de validação via SMS
- Confirmando o código recebido via SMS