Índice

flat

outline	true	type

Portuguese (Brasil)

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
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

Monitor de Processo de Integração - Process
Campo	Tipo	Obrig.	Descrição	Regra
company	String	Sim

Empresa do

Código da empresa no sistema PontoWeb
unique	String	Sim	Unique de identificação do processo	É gerado um a cada

15

10 minutos tem validade de

15

10 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

10 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

Exemplo de Requisição (

Json)Request (Chamadas de Solicitação)

Request)

Bloco de código

language	text
theme	Emacs

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

99999999

99999999

Exemplos de respostas (Responses)

Resposta quando SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

Response (Retornos)Solicitação bem sucedida (Sucesso) - Code 200{

"data":

{

 {
        "errors": []

},


    "company": "

a133595

a546410",


    "unique": "

8dbf32bc

50ed3411",


    "subunique": "

f74277ef

7ef8d189",


    "status": "done",


    "progress":

{

 {
        "done": "1",


        "total": "1"

}
}Solicitação bem sucedida (Erros) - Code 200{

}
}

Resposta quando SUCESSO reportando erros de people - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
   "data":

{

 {
        "errors":

[
{

 [
            {
                "identifier": "01011",


                "message":

[
"CPF Inválido",

 [
                    "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

}
}

Resposta quando SUCESSO reportando erros de absences - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "data": {
        "errors": [
            {
                "identifier": "A1902",
                "message": [
                    "matrícula: 998877 - O afastamento possui intersecção com outro(s) já cadastrado(s)."
                ]
            }
        ]
    },
    "company": "a546410",
    "unique": "50691fb4",
    "subunique": "dc8ab430",
    "status": "warning",
    "progress": {
        "done": "1",
        "total": "1"
    }
}

ERRO de Autenticação - Code 400:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

ERRO de Autenticação - Code 401:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

ERRO de Permissão - Code 403:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

Forbidden

ERRO de Permissão - Code 410:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

English (US)

Integration Process Monitor

Service used to obtain the detailed result of a request from the main services such as people, absences, and so on.

Integration Process Monitor

Item	Description
Flow:	Client → PontoWeb
Route	https://api.ahgora.com.br/process
Method:	GET
Use cases	people absences paymentDate anticipate subsidiaries costcenter users

Query Params
Key	Value
Accept-Version	v2

Integration Process Monitor
Field	Type	Required	Description	Rules
company	String	Yes	Company code in the PontoWeb system
unique	String	Yes	Unique process identification	One is generated every 15 minutes and is valid for 15 minutes (if there are no new requests within this period).
subunique	String	Yes	Process subunique	One is generated for each request and is valid for 15 minutes
status	String	Yes	Process status	"done": All the items in the request were successful; "warning": Some item in the request has shown an error; "error": All the items in the requisition showed an error;
progress	Object	Yes	Property that shows the process totals
done	String	Yes	Completed
total	String	Yes	Total Processed
data	Object	Yes	Property that stores the results of the process
errors	Array	Yes	Property that lists the errors presented
identifier	String	Yes, when there are errors	Employee's Registration
mensage	String	Yes, when there are errors	Error message

Request examples:

Bloco de código

language	text
theme	Emacs

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

Responses examples:

Response when SUCCESS - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Response when SUCCESS reporting people errors - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Response when SUCCESS reporting absences errors - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "data": {
        "errors": [
            {
                "identifier": "A1902",
                "message": [
                    "matrícula: 998877 - O afastamento possui intersecção com outro(s) já cadastrado(s)." //The leave intersects with other(s) already registered
                 ]
            }
        ]
    },
    "company": "a546410",
    "unique": "50691fb4",
    "subunique": "dc8ab430",
    "status": "warning",
    "progress": {
        "done": "1",
        "total": "1"
    }
}

Authentication ERROR - Code 400:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Authentication ERROR - Code 401:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Permission ERROR - Code 403:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

Forbidden

Permission ERROR - Code 410:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

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

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

Monitor de Processo de Integração (Process)

Exemplo de Requisição (

Request)

Exemplos de respostas (Responses)

Resposta quando SUCESSO - Code 200:

Resposta quando SUCESSO reportando erros de people - Code 200:

Resposta quando SUCESSO reportando erros de absences - Code 200:

ERRO de Autenticação - Code 400:

ERRO de Autenticação - Code 401:

ERRO de Permissão - Code 403:

ERRO de Permissão - Code 410:

Integration Process Monitor

Request examples:

Responses examples:

Response when SUCCESS - Code 200:

Response when SUCCESS reporting people errors - Code 200:

Response when SUCCESS reporting absences errors - Code 200:

Authentication ERROR - Code 400:

Authentication ERROR - Code 401:

Permission ERROR - Code 403:

Permission ERROR - Code 410:

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

Monitor de Processo de Integração (Process)

Exemplo de Requisição (

Request)

Exemplos de respostas (Responses)

Resposta quando SUCESSO - Code 200:

Resposta quando SUCESSO reportando erros de people - Code 200:

Resposta quando SUCESSO reportando erros de absences - Code 200:

ERRO de Autenticação - Code 400:

ERRO de Autenticação - Code 401:

ERRO de Permissão - Code 403:

ERRO de Permissão - Code 410:

Integration Process Monitor

Request examples:

Responses examples:

Response when SUCCESS - Code 200:

Response when SUCCESS reporting people errors - Code 200:

Response when SUCCESS reporting absences errors - Code 200:

Authentication ERROR - Code 400:

Authentication ERROR - Code 401:

Permission ERROR - Code 403:

Permission ERROR - Code 410: