Integration Process Monitor (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 |
| Rota | https://api.ahgora.com.br/process |
| Método: | GET |
| Usos | people absences paymentDate anticipate subsidiaries costcenter users |
| Query Params | |
|---|---|
| Chave | Valor |
| Accept-Version | v2 |
| Integrador 2.0 | ||||
| Campo | Tipo | Obrig. | Descrição | Regra |
| company | String | Sim | Empresa do PontoWeb | |
| unique | String | Sim | Unique 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). |
| subunique | String | Sim | Subunique do processo | É gerado um a cada request e tem validade de 15 minutos |
| status | String | Sim | Status 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. |
| progress | Objeto | Sim | Propriedade que apresenta os totais do processo | |
| done | String | Sim | Finalizado | |
| total | String | Sim | Total Processado | |
| data | Objeto | Sim | Propriedade que armazena os resultados do processo | |
| errors | Array | Sim | Propriedade que lista os erros apresentados | |
| identifier | String | Sim, quando há erros | Matrícula/Registro do Funcionário | |
| mensage | String | Sim, quando há erros | Mensagem de erro | |
| Exemplos (Json) | ||||
| Request (Chamadas de Solicitação) | ||||
| https://api.ahgora.com.br/process?subunique=99999999 | ||||
| Response (Retornos) | ||||
| Solicitação bem sucedida (Sucesso) - Code 200 | ||||
| { "data": { "errors": [] }, "company": "a133595", "unique": "8dbf32bc", "subunique": "f74277ef", "status": "done", "progress": { "done": "1", "total": "1" } } | ||||
| Solicitação bem sucedida (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" } } | ||||
| Subunique inválido ou expirado - Code 410 | ||||
| { "company": "a000101", "subunique": "bd751350", "message": "Process SubUnique Expired or Invalid" } | ||||
| Autenticação (Erro) - Code 401 | ||||
| { "error": { "code": 401, "message": "Unauthorized" } } | ||||