Monitor de Processo de Integração (Process)


Serviço utilizado para obter o resultado detalhado de uma requisição dos serviços principais como people, absences, etc.


Integration Process Monitor (Process)

Item

Descrição

Fluxo:Cliente → PontoWeb
Rotahttps://api.ahgora.com.br/process
Método:GET
Usos

people

absences

paymentDate

anticipate

subsidiaries

costcenter

users

Query Params
ChaveValor
Accept-Versionv2
Monitor de Processo de Integração - Process
CampoTipoObrig.DescriçãoRegra
companyStringSimCódigo da empresa no sistema PontoWeb
uniqueStringSimUnique de identificação do processoÉ gerado um a cada 15 minutos tem validade de 15 minutos (se não houver novas requisições dentro deste período).
subuniqueStringSimSubunique do processoÉ gerado um a cada request e tem validade de 15 minutos
statusStringSimStatus do processo"done"(Finalizado): Todos os itens da requisição apresentaram sucesso;
"
warning"(Alerta): Algum item da requisição apresentou erro;
"
error"(Erro): Todos os itens da requisição apresentaram erro.
progressObjetoSimPropriedade que apresenta os totais do processo
doneStringSimFinalizado
totalStringSimTotal Processado
dataObjetoSimPropriedade que armazena os resultados do processo
errorsArraySimPropriedade que lista os erros apresentados
identifierStringSim, quando há errosMatrícula/Registro do Funcionário
mensageStringSim, quando há errosMensagem de erro


Exemplo de Requisição (Request)


https://api.ahgora.com.br/process?subunique=99999999


Exemplos de respostas (Responses)

Resposta quando SUCESSO - Code 200:

{
    "data": {
        "errors": []
    },
    "company": "a546410",
    "unique": "50ed3411",
    "subunique": "7ef8d189",
    "status": "done",
    "progress": {
        "done": "1",
        "total": "1"
    }
}



Respostaquando SUCESSO reportando erros - Code 200:

{
   "data": {
        "errors": [
            {
                "identifier": "01011",
                "message": [
                    "CPF Inválido",
                    "E-mail já cadastrado.",
                    "PIS já cadastrado."
                ]
            }
        ]
    },
    "company": "a133595",
    "unique": "8dbf32bc",
    "subunique": "e1e8eb4b",
    "status": "error",
    "progress": {
        "done": "1",
        "total": "1"
    }
}


ERRO de Autenticação - Code 400:

{
  "error": "Request format must be an Array"
}


ERRO de Autenticação - Code 401:

{
  "error": {
    "message": "Unauthorized",
    "code": 401
  }
}


ERRO de Permissão - Code 403:

Forbidden


ERRO de Permissão - Code 410:

{
  "message": "Process Unique \"subunique\" Expired or Invalid",
  "company": "a000101",
  "subunique": "c01de0cc"
}