Está página apresenta os métodos disponíveis para interação com usuários na API local do Identify, com exemplos de consumo e as tabelas dos campos esperados e retornados por cada método.
As alterações realizadas tem impacto nos dados mantidos pela NS, de modo que uma alteração na foto de perfil, alterará a foto do usuário em todos os locais que for reconhecido
Registrar Pessoa
Este endpoint realiza o cadastro de uma pessoa no sistema do Identify.
URL
POST http://localhost:8080/api/people/register
Dados de entrada
Envio de dados em formato JSON
Para envio dos dados em JSON, o Content-Type da requisição deverá ser definido como application/json.
Campo | Descrição | Tipo | Ocorrência | Observação |
---|---|---|---|---|
nome | Nome da pessoa a ser cadastrada | String | 1-1 | |
Email da pessoa a ser cadastrada | String | 1-1 | ||
fotoperfil | Base64 da imagem a ser utilizada como foto de perfil | String | 1-1 | |
imagens | Lista de imagens(base64) da pessoa para treinamento | Object | 1-1 | Pelo menos 2 imagens |
Exemplo de requisição
<code>curl -X POST \
-H "Content-Type: application/json"</code> <code>\
-d '{
"nome": "Matheus",
"email": "email@do.matheus",
"fotoperfil":"iVBORw0KGgoAAAANSUhEUgAAAUAAAADwCAYABx...",
"imagens":[
"iVBORw0KGgoAAAANSUhEUgAAAUAAAADwCAYAAABxLb1rA...",
"iVBORw0KGgoAAAANSUhEUgAAAUAAAADwCAYAAABxLb1rA..."
]
}'
\http://localhost:8080/api/people/register</code>
Dados retornados
Campo | Descrição | Tipo | Ocorrência | Observação |
---|---|---|---|---|
status | Código de status do processamento | Integer | 1-1 | |
motivo | Descrição literal do status de processamento | String | 1-1 | |
idface | Hash que representa o candidato | String | 0-1 | Somente em status 200 |
retornoimagens | Lista das descrições de retorno do envio das imagens para treinamento | Object | 0-1 | Somente em status 200 |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Operacao realizada com sucesso",
"idface": "6gji49i-9tj1...",
"retornoimagens": [
"Operacao realizada com sucesso",
"Operacao realizada com sucesso"
]
}
Códigos de retorno
Código | Descrição |
---|---|
200 | Operacao realizada com sucesso |
-1 | Requisicao mal formatada |
-2 | O campo imagens deve conter pelo menos 2 imagem(s) |
-3 | Erro ao tentar criar usuario: DESCRICAO_DO_ERRO |