lemonstand/amzn-login-and-pay-with-amazon-sdk-php

Forked Amazon Login and Pay with Amazon SDK package. Package will use phoenix branch.

Login and Pay with Amazon PHP SDK

Login and Pay with Amazon API Integration, _(*1)

Requirements

• PHP 5.3 or higher
• Curl 7.8

Quick Start

Instantiating the client: Client Takes in parameters in the following format, _(*2)

1. Associative array
2. Path to the JSON file containing configuration information.

Parameters List

Mandatory Parameters

Optional Parameters

Setting Configuration

Setting configuration while instantiating the OffAmazonPaymentsService_Client object, _(*3)

require 'Client.php'
// Your Login and Pay with Amazon keys are
// available in your Seller Central account

// PHP Associative array
$config = array('merchant_id' => 'YOUR_MERCHANT_ID',
                'access_key'  => 'YOUR_ACCESS_KEY',
                'secret_key'  => 'YOUR_SECRET_KEY',
                'client_id'   => 'YOUR_LOGIN_WITH_AMAZON_CLIENT_ID',
                'region'      => 'REGION');

// JSON file path            
$config = 'PATH_TO_JSON_FILE';

//Instantiate the client class with the config type
$client = new OffAmazonPaymentsService_Client($config);

Testing in Sandbox Mode

The sandbox parameter is defaulted to false if not specified:, _(*4)

$config = array('merchant_id'   => 'YOUR_MERCHANT_ID',
                'access_key'    => 'YOUR_ACCESS_KEY',
                'secret_key'    => 'YOUR_SECRET_KEY',
                'client_id'     => 'YOUR_LOGIN_WITH_AMAZON_CLIENT_ID',
                'region'        => 'REGION',
                'sandbox'       => true );

$client = new OffAmazonPaymentsService_Client($config);

//Also you can set the sandbox variable in the _config() array of the Client class by 

$client->setSandbox(true);

Setting Proxy values

Proxy parameters can be set after Instantiating the Client Object with the following setter, _(*5)

$proxy =  array();
$proxy['proxy_user_host'] // hostname for the proxy
$proxy['proxy_user_port'] // hostname for the proxy
$proxy['proxy_user_name'] // if your proxy requires a username
$proxy['proxy_user_password'] // if your proxy requires a password

$client->setProxy($proxy);

Making an API Call

Below is an example on how to make the GetOrderReferenceDetails API call:, _(*6)

$requestParameters = array();

// AMAZON_ORDER_REFERENCE_ID is obtained from the Pay with Amazon Address/Wallet widgets
// ACCESS_TOKEN is obtained from the GET parameter from the URL.

//Required Parameter
$requestParameters['amazon_order_reference_id'] = 'AMAZON_ORDER_REFERENCE_ID';

//Optional Parameter
$requestParameters['address_consent_token']     = 'ACCESS_TOKEN';
$requestParameters['mws_auth_token']        = 'MWS_AUTH_TOKEN';

$response = $client->getOrderReferenceDetails($requestParameters);

IPN Handling

1. To receive IPN's successfully you will need an valid SSL on your domain.
2. You can set up your Notification endpoints in Seller Central by accessing the Integration Settings page in the Settings tab.
3. IpnHandler.php class handles verification of the source and the data of the IPN

Add the below code into any file and set the URL to the file location in Merchant/Integrator URL by accessing Integration Settings page in the Settings tab., _(*7)

require_once 'IpnHandler.php';

//get the IPN headers and Message body
$headers    = getallheaders();
$body       = file_get_contents('php://input');

//create an  object($ipnHandler) of the IpnHandler class 
$ipnHandler = new IpnHandler($headers, $body);

Convenience Methods

Charge Method

Charge method combines the following API calls, _(*8)

Standard Payments / Recurring Payments, _(*9)

1. SetOrderReferenceDetails / SetBillingAgreementDetails
2. ConfirmOrderReference / ConfirmBillingAgreement
3. Authorize (With capture) / AuthorizeOnBillingAgreement (With capture)

//create an array that will contain the parameters for the Charge API call
$requestParameters = array();

//Adding the parameters values to the respective keys in the array
$requestParameters['amazon_reference_id'] = 'AMAZON_REFERENCE_ID';
$requestParameters['seller_id'] = null;
$requestParameters['charge_amount'] = '100.50';
$requestParameters['currency_code'] = 'USD';
$requestParameters['authorization_reference_id'] = 'UNIQUE STRING';
$requestParameters['transaction_timeout'] = 0;
$requestParameters['charge_note'] = 'Example item note';
$requestParameters['charge_order_id'] = '1234-Example-Order';
$requestParameters['Store_Name'] = 'Example Store';
$requestParameters['Platform_Id'] = null;
$requestParameters['Custom_Information'] = 'Any_Custom_String';
$requestParameters['mws_auth_token'] = null;

//get the Authorization response from the charge method
$response = $client->charge($requestParameters);

Obtain profile information (getUserInfo method)

1. obtains the user's profile information from Amazon using the access token returned by the Button widget.
2. An access token is granted by the authorization server when a user logs in to a site.
3. An access token is specific to a client, a user, and an access scope. A client must use an access token to retrieve customer profile data.

//config array parameters that need to be instantiated
$config = array('client_id' => 'YOUR_LWA_CLIENT_ID',
                'region'    => 'REGION' );

$client = new OffAmazonPaymentsService_Client($config);

//Client ID can also be set using the setter function setClientId($client_id)
$client->setClientId(‘YOUR_LWA_CLIENT_ID’);

//Get the Access Token from the URL
$access_token = 'ACCESS_TOKEN';
//calling the function getUserInfo with the access token parameter returns object
$userInfo = $client->getUserInfo($access_token);

//Buyer name
$userInfo['name'];
//Buyer Email
$userInfo['email'];
//Buyer User Id
$userInfo['user_id'];

Response Parsing

Responses are provided in 3 formats, _(*10)

1. XML/Raw response
2. Associative array
3. JSON format

API Response

//Returns an object($response) of the class ResponseParser.php
$response = $client->getOrderReferenceDetails($requestParameters);

//XML response
$response->toXml();

//Associative array response
$response->toArray();

//JSON response
$response->toJson();

IPN Response

$ipnHandler = new IpnHandler($headers, $body);

//Raw message response
$ipnHandler->returnMessage();

//Associative array response
$ipnHandler->toArray();

//JSON response
$ipnHandler->toJson();