Está página apresenta os métodos disponíveis na API local do Identify, com exemplos de consumo e as tabelas dos campos esperados e retornados por cada método.
Parar Detecção
Este serviço para a detecção do Identify até o fim de sua execução ou até a chamada do método para retomar a detecção.
URL
POST http://localhost:8080/api/operation/pause
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 |
---|---|---|---|---|
clean | Limpar lista de pessoas reconhecidas recentemente | Boolean | 0-1 |
Exemplo de requisição
curl -X POST
\-H "Content-Type: application/json"
\-d '{"clean": true}'
\http://localhost:8080/api/operation/pause
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 |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Operacao realizada com sucesso"
}
Códigos de retorno
Código | Descrição |
---|---|
200 | Operacao realizada com sucesso |
Retomar Detecção
Este serviço reativa uma detecção parada do Identify.
URL
POST http://localhost:8080/api/operation/resume
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 |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Operacao realizada com sucesso"
}
Códigos de retorno
Código | Descrição |
---|---|
200 | Operação realizada com sucesso |
Limpar Detecção
Este serviço limpa a lista de pessoas reconhecidas recentemente, sem parar o serviço de detecção.
URL
POST http://localhost:8080/api/operation/clean
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 |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Operacao realizada com sucesso"
}
Códigos de retorno
Código | Descrição |
---|---|
200 | Operação realizada com sucesso |