TOTVS RH Linha Ahgora Integrador

Árvore de páginas

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
Routehttps://api.ahgora.com.br/process
Method:GET
Use cases

people

absences

paymentDate

anticipate

subsidiaries

costcenter

users

Query Params
KeyValue
Accept-Versionv2
Integration Process Monitor
FieldTypeRequiredDescriptionRules
companyStringYesCompany code in the PontoWeb system
uniqueStringYesUnique process identificationOne is generated every 15 minutes and is valid for 15 minutes (if there are no new requests within this period).
subuniqueStringYesProcess subuniqueOne is generated for each request and is valid for 15 minutes
statusStringYesProcess 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;
progressObjectYesProperty that shows the process totals
doneStringYesCompleted
totalStringYesTotal Processed
dataObjectYesProperty that stores the results of the process
errorsArrayYesProperty that lists the errors presented
identifierStringYes, when there are errorsEmployee's Registration
mensageStringYes, when there are errorsError 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"
}