Comptroller General of the Republic - Colombia
Lets integrate Comptroller General of the Republic - Colombia in your system. First, get your Apitude API key, then send a POST request to Apitude... And that's it!.
That POST request should return the following
{
"message": "Request processed successfully",
"url": "/api/v1.0/requests/contraloria-co/e0606c19-a32d-410f-b2eb-d57a665677bc/",
"request_id": "e0606c19-a32d-410f-b2eb-d57a665677bc"
}
This response will contains a unique request ID that you should poll using a GET as follows
How does the response looks like?
{
"result": {
"data": {
"reported": true
},
"error": "",
"end_at": "2020-07-06 06:56:21.048528",
"status": 200,
"message": "successful",
"queried_by": "YOUR-USER",
"service_name": "contraloria-co"
},
"message": "Request completed"
}
Ok, but what does each field in that JSON means?
The general parts:
message:
The message is an Apitude generatedstring
with an informational text about the request.result:
The result is contains the main part of the request.result.error:
The error is astring
generated by apitude for the request if everything worked it will be blank.result.message:
The message is astring
with two optionssuccessful
orunsuccessful
depending of how your request finished.result.queried_by:
The queried_by field is astring
that lets you know what user started the request.result.end_at:
The end_at field is astring formatted date
that lets you know at what time the request ended in Apitude.result.service_name:
The service_name field is astring
that echos the service called. For this service it will always becontraloria-co
.result.status:
The status field is ainteger
that represents whether the service returned data from the input sent in the request. It could be one of the following values:200
: The service returned response data for the payload that was sent in the creation of the request.404
: The service did not returned data for the payload that was sent in the creation of the request.400
: The service did not started because your input was invalid.500
: Apitude tried to execute your request, however the service Apitude uses to execute your request was down. Please wait some time and try again, Apitude will not charged you for requests with this code.
Depending on the service, you want it to return different codes. For example, if you are checking the user against a security list to whitelist the user you should look for a
404
, because a200
would mean the user is in fact in the list. Other cases however, like creating objects in the name of a user you want the code to be200
, since it will imply the creation was a success.
The data in the response:
Please refer to the official docs of this service online to find out more about what data is returned.
About this service
This service allows to obtain through API, the people who are reported by the comptroller of Colombia.
Who can you query using this service?:
This service (contraloria-co) is available for you to query individuals only.
Get API Access