aws-samples/mturk-code-samples

Code samples to help you get started with the Amazon Mechanical Turk Requester API

Amazon Mechanical Turk Requester API Code Samples

In 2017 Amazon Mechanical Turk (MTurk) launched support for AWS Software Development Kits. Requesters can now programmatically access MTurk with nine new SDKs.

As part of this launch, MTurk also released a new version of the Requester API (version: ‘2017–01–17’). This version significantly updates naming conventions used in the API and adopts the latest AWS authentication and authorization standard of Signature Version 4. The API uses REST and no longer requires developers to also be familiar with SOAP. These changes make the MTurk API consistent with other AWS APIs, simplifying the on-boarding process for both new and existing AWS developers. You can explore the full API reference documentation here.

This repo contains code samples to help you get started with the AWS SDKs and the updated API.

Get Started

1. Set up your AWS account and your MTurk Requester and Developer Sandbox accounts as described here.

2. Download and set up the SDK of your choice: Python/Boto3, Javascript (NodeJS or Browser), Java, .NET, Go, Ruby, PHP or C++.

3. Configure the AWS SDK to use the ‘us-east-1’ region. This is the region in which the MTurk API is available.

4. Connect to the MTurk Developer Sandbox and check your account balance (the Sandbox should always return a balance of $10,000). To connect to the MTurk Developer Sandbox, set the API endpoint in your SDK to https://mturk-requester-sandbox.us-east-1.amazonaws.com. You can find examples here in various languages.

5. Explore the code samples available in this repo to see how to use the updated API and the SDKs to submit tasks and get back results from MTurk.

6. Use the MTurk API reference to explore all the operations available.

mturk-code-samples's Issues

PHP example

<?php
    require(__DIR__."/vendor/autoload.php");

    $access_id = "XXX";
    $key = "YYY";

    $turk = new Aws\MTurk\MTurkClient([
        'credentials' => [
            'key'    => $access_id,
            'secret' => $key
        ],
        'version' => 'latest',
        'region'  => 'us-east-1'
    ]);
    $res = $turk->listHITs();
    print_r($res);
?>

SDK 2 examples

It seems that the examples in this repository are for the old 1.x version of the AWS SDK. Are there any plans to provide further examples for the new SDK 2?

(I've also raised this same issue on the dedicated SDK 2 examples repository.)