Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforapps.com/api-dashboard
<?php // You can download this file from here https://api.dataforapps.com/v3/_examples/php/_php_RestClient.zip require('RestClient.php'); $api_url = 'https://api.dataforapps.com/'; try { // Instead of 'login' and 'password' use your credentials from https://app.dataforapps.com/api-dashboard $client = new RestClient($api_url, null, 'login', 'password'); } catch (RestClientException $e) { echo "\n"; print "HTTP code: {$e->getHttpCode()}\n"; print "Error code: {$e->getCode()}\n"; print "Message: {$e->getMessage()}\n"; print $e->getTraceAsString(); echo "\n"; exit(); } try { // using this method you can get a list of errors // GET /v3/appendix/errors $result = $client->get('/v3/appendix/errors'); print_r($result); // do something with result } catch (RestClientException $e) { echo "\n"; print "HTTP code: {$e->getHttpCode()}\n"; print "Error code: {$e->getCode()}\n"; print "Message: {$e->getMessage()}\n"; print $e->getTraceAsString(); echo "\n"; } $client = null; ?>
The above command returns JSON structured like this:
{ "version": "0.1.20230825", "status_code": 20000, "status_message": "Ok.", "time": "0.0782 sec.", "cost": 0, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "11011828-6944-0161-3000-73689637de5e", "status_code": 20000, "status_message": "Ok.", "time": "0.0000 sec.", "cost": 0, "result_count": 46, "path": [ "v3", "appendix", "errors" ], "data": { "api": "appendix", "function": "errors" }, "result": [ { "code": 20000, "message": "Ok." }, { "code": 20100, "message": "Task Created." }, { "code": 40000, "message": "You can set only one task at a time." }, { "code": 40001, "message": "This id is used by another client, check the id." }, { "code": 40002, "message": "This id is used by another search engine, check the Path." }, { "code": 40003, "message": "This id is used by another search type, check the Path." }, { "code": 40004, "message": "This id is used by another function, check the id." }, { "code": 40006, "message": "You can set no more than 100 tasks at a time." }, { "code": 40100, "message": "You are not authorized to access this resource. See your login details here: https://app.dataforapps.com/api-dashboard ." }, { "code": 40101, "message": "Internal SE Server Error." }, { "code": 40102, "message": "No Search Results." } ] } ] }
This endpoint returns a list of possible DataForApps API errors and general status codes. Below you will find a list of HTTP response codes and internal messages. We recommend storing the data connected to error codes in your application log and designing a necessary system for handling related exceptional or error conditions.
Note: DataForApps API servers always return the 200
HTTP response code, except for the following cases.
HTTP response codes:
Code | Message | Description |
---|---|---|
401 |
Unauthorized | You are not authorized to access this resource. See your login details here: https://app.dataforapps.com/api-dashboard |
402 |
Payment Required | We had a problem billing your account. Please, check your account’s balance. |
404 |
Not Found | Requested endpoint not found |
500 |
Internal Server Error | Sorry, we could not process your request due to the internal server error. Please, try again later. |
Alongside the 200
HTTP code, our system also generates internal status codes which you may find in status_code
and status_message
fields of the API response.
Note: status messages can be expanded in the API response and may vary depending on the event that triggered them.
You can also get the list of internal error codes by calling the ‘Errors’ endpoint:
By calling this endpoint you will receive information about the possible error codes.
As a response of the API server, you will receive JSON-encoded data containing a tasks
array with the information specific to the set tasks.
Field name | Type | Description |
---|---|---|
version |
string | the current version of the API |
status_code |
integer | general status code you can find the full list of the response codes here |
status_message |
string | general informational message you can find the full list of general informational messages here |
time |
string | total execution time, seconds |
cost |
float | total tasks cost, USD |
tasks_count |
integer | the number of tasks in the tasks array |
tasks_error |
integer | the number of tasks in the tasks array returned with an error |
tasks |
array | array of tasks |
id |
string | task identifier unique task identifier in our system in the UUID format |
status_code |
integer | status code of the task generated by DataForApps, can be within the following range: 10000-60000 you can find the full list of the response codes here |
status_message |
string | informational message of the task you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | cost of the task, USD |
result_count |
integer | number of elements in the result array |
path |
array | URL path |
data |
array | contains the same parameters that you specified in the POST request |
result |
array | array of results |
code |
integer | code |
message |
string | message |
Alongside the 200
HTTP code, our system also generates internal status codes which you may find in status_code
and status_message
fields of the API response.
Note: status messages can be expanded in the API response and may vary depending on the event that triggered them.
Internal status codes and messages:
Code | Message | Description |
---|---|---|
20000 |
Ok. | the request has been successfully completed |
20100 |
Task Created. | as a result of the successful request, the task has been created |
40000 |
You can set only one task at a time. | you cannot specify more than one task in the POST array |
40001 |
This id is used by another client, check the id. | the task identifier id is unique to the client used to send the request |
40002 |
This id is used by another search engine, check the Path. | the task identifier id is unique to the search engine used in the URL path of the request |
40003 |
This id is used by another search type, check the Path. | the task identifier id is unique to the search type used in the URL path of the request |
40004 |
This id is used by another function, check the id. | the task identifier id is unique to the function used in the URL path of the request |
40006 |
You can set no more than 100 tasks at a time. | each POST request can contain up to 100 tasks |
40100 |
You are not authorized to access this resource. See your login details here: https://app.dataforapps.com/api-dashboard . | check if the specified credentials match those in your account dashboard |
40101 |
Internal SE server error. | the requested search engine was unable to process your request and responded with an error |
40102 |
No Search Results. | no results matching the details of your request have been found |