Jobs API
The Jobs-API manages manual crawls. The Jobs-API can be found at endpoint
https://www.consentmanager.net/api/job.phpCreate a new job
In order to create a new job, please send a HTTP POST to the Jobs-API with the following parameters:
|
Parameter |
Description |
Example |
|
key |
Authentication Key |
jf892rt |
|
url |
URL to be crawled |
https://www.cnn.com/ |
Create Job Result
The API will return the following object:
{
"status":"created", //status, always “created”
"message": "Job created", //status message
"jobid": "..." //job ID, varchar(64)
}Fetch a job result
In order to fetch the result for a job, please send a HTTP GET to the Jobs-API with the following parameters:
|
Parameter |
Description |
Example |
|
key |
Authentication Key |
jf892rt |
|
jobid |
ID of the job (property “jobid” from Create Job Result) |
22-a6c51bfb |
Fetch Job Result
The API will return the following object:
{
"status":"done", //status, either pending or done
"message": "Job done", //status message
"risk": 75, //calculated risk, only present if status=done
"reporturl": "..." //Report-URL, only present if status=done
}Error codes
The following error codes may occur:
|
HTTP Code |
Desciption |
|
400 |
Incorrect parameters submitted |
|
403 |
Incorrect Key |
|
404 |
Data not found |
|
429 |
Max jobs/calls per day limit reached |
