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:

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

Responses examples:

Response when SUCCESS - Code 200:

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

Response when SUCCESS reporting people errors - Code 200:

{
   "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:

{
    "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:

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

Authentication ERROR - Code 401:

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

Permission ERROR - Code 403:

Forbidden

Permission ERROR - Code 410:

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