jpcaparas/trademe-php-api

A PHP client for the Trade Me API

v0.2 2019-04-13 03:41 UTC

Requires

• php: ^7.1
• ext-curl: *
• ext-json: *
• guzzlehttp/guzzle: ^6.3
• guzzlehttp/oauth-subscriber: ^0.3.0

Requires (Dev)

• phpspec/prophecy: ^1.8
• phpunit/phpunit: ^8.1
• symfony/var-dumper: ^4.2

MIT

• JP Caparas

• trademe
• trade-me

README

An unofficial PHP client to make it easy to interface with Trade Me's API platform.

Installation

composer require jpcaparas/trademe-php-api

Authorizing

Getting temporary access tokens (Step 1)

$config = [
    'sandbox' => true,
    'oauth' => [
        'consumer_key' => 'foo',
        'consumer_secret' => 'bar',
    ],
];
    
$client = new \JPCaparas\TradeMeAPI\Client($config);

['oauth_token' => $tempAccessToken, 'oauth_token_secret' => $tempAccessTokenSecret] = $client->getTemporaryAccessTokens();

Getting the OAuth token verifier to validate temporary access tokens (Step 2)

$tokenVerifierUrl = $client->getAccessTokenVerifierURL($tempOAuthToken); // Visit this URL and store the verifier code

Getting the final access tokens (Step 3)

// The config values are a culmination of steps 1 and 2
$config = [
    'temp_token' => 'baz',
    'temp_token_secret' => 'qux',
    'token_verifier' => 'quux'
];

['oauth_token' => $accessToken, 'oauth_token_secret' => $accessTokenSecret] = $client->getFinalAccessTokens($config);

Making API calls

You can make API calls once you've gotten your final access tokens:

Selling an item

$config = [
    'sandbox' => true,
    'oauth' => [
        'consumer_key' => 'foo',
        'consumer_secret' => 'bar',
        'token' => 'baz',
        'token_secret' => 'qux',
        'token_verifier' => 'quu',
    ],
];

$client = new Client($config);

$params = [
    'Category' => 'TestCategory',
    'Title' => 'TestTitle',
    'Description' => ['TestDescriptionLine1'],
    'Duration' => 1,
    'BuyNowPrice' => 99,
    'StartPrice' => 90,
    'PaymentMethods' => [2, 4],
    'Pickup' => 1,
    'ShippingOptions' => [
        ['Type' => 1],
    ],
];

$client->sellItem($params);

Tests

vendor/bin/phpunit

References

• OAuth 1.0 PLAINTEXT workflow (link)
• API reference (link)