API documentation
Account
Basic Campaigns
- GET
- /campaign_b/get_task_info/
- /campaign_b/list_tasks/
- /campaigns_b/list
- /campaigns_b/list_extend
- /campaign_b/list_tasks_extend/
- /campaign_b/get_status/
- /campaign_b/get_info/
- /campaign_b/download_file_proof/
- /campaign_b/zones_list/
- /campaign_b/categories_list/
- /campaign_b/get_worker_tasks/
- /campaign_b/results_csv/
- POST, PUT
- /campaign_b/set_speed/
- /campaign_b/new_campaign
- /campaign_b/stop/
- /campaign_b/pause/
- /campaign_b/resume/
- /campaign_b/rate_task/
- /campaign_b/rate_tasks/
- /campaign_b/add_positions/
- /campaign_b/submit_proof/
- /campaign_b/submit_file_proof/
- /campaign_b/retarget/
- /campaign_b/restart_campaign/
- /campaign_b/toggle_qt_required/
HG Campaigns
- GET
- /campaign_hg/get_task_info/
- /campaign_hg/list_tasks/
- /campaign_hg/list_tasks_extend/
- /campaigns_hg/list
- /campaigns_hg/list_extend
- /campaign_hg/get_status/
- /campaign_hg/get_info/
- /campaign_hg/categories_list/
- /campaign_hg/groups_list/
- /campaign_hg/download_file_proof/
- /campaign_hg/get_worker_tasks/
- /campaign_hg/results_csv/
- POST, PUT
- /campaign_hg/new_campaign
- /campaign_hg/stop/
- /campaign_hg/pause/
- /campaign_hg/resume/
- /campaign_hg/rate_task/
- /campaign_hg/rate_tasks/
- /campaign_hg/add_positions/
- /campaign_hg/submit_proof/
- /campaign_hg/submit_file_proof/
- /campaign_hg/lock_task/
- /campaign_hg/change_group/
- /campaign_hg/restart_campaign/
- /campaign_hg/toggle_qt_required/
Employer
- GET
- /employer/exclude_list
- POST
- /employer/exclude_list
- DELETE
- /employer/exclude_list
Worker
Messages
/campaign_hg/submit_proof/<campaign_id> PUT
Submit worker's proof.
Parameters:
Campaign ID
Example values: e7162dd17b83
Worker's ID
Worker's IP address
Random Key
Proofs submitted by Worker
(Optional) Revise task ID. You must provide this parameter if worker submitting proof to existing task rated as REVISE
Return values:
status=SUCCESS, campaign_id=[campaign id], task_id=[task id], extra_positions=[how many extra positions worker can take]
status=ERROR, campaign_id=[campaign id], error=[error message*]
*[NO SUCH CAMPAIGN|UNKNOWN WORKER|SYSTEM ERROR|INPUT_DATA|IP address does not match.|No random key.|This task has expired. Worker did not finish it on time.|Proof is required.|VCODE is incorrect.|REVISE TASK DOES NOT EXIST]
Code:
cURL:
PHP:
Perl:
Python:
C#:
Examples:
Output (Success):
{
"status": "SUCCESS",
"campaign_id": "a699bb9b2e7b",
"task_id": "54321",
"extra_positions": "0"
}
Output (Error):
{
"status": "ERROR",
"campaign_id": "a699bb9b2e7b",
"error": "NO SUCH CAMPAIGN"
}