researchpanelasia/sopx-auth-v1_1

SOP v1.1 authentication

, _(*1)

NAME

SOPx_Auth_V1_1 - SOP v1.1 authentication module, _(*2)

SYNOPSIS

$auth = new \SOPx\Auth\V1_1\Client('<APP_ID>', '<APP_SECRET>');

$request = $auth->createRequest(
  'GET', 'https://<API_HOST>/path/to/endpoint',
  array('app_id' => '<APP_ID>', 'app_mid' => '<APP_MID>', ... )
);
//=> isa GuzzleHttp\Psr7\Request object

OR, _(*3)

$sig = \SOPx\Auth\V1_1\Util::createSignature(
  array(
    'app_id' => '<APP_ID>',
    'app_mid' => '<APP_MID>',
    'time' => $time,
    ...
  ), '<APP_SECRET>'
);
//=> HMAC SHA256 hash signature

DESCRIPTION

This module enables you to generate SOP v1.1 signature, make HTTP request to SOP v1.1 API., _(*4)

HOW TO USE

Making a valid request to SOP API endpoint

  $auth = new \SOPx\Auth\V1_1\Client('<APP_ID>', '<APP_SECRET>');

  $request = $auth->createRequest(
    'GET',
    'https://<API_HOST>/path/to/endpoint',
    array(
      'param1' => 'foo',
      'param2' => 'bar',
      ...
    )
  );

  // Then use Guzzle HTTP client to send request

Creating a valid URL (e.g., for JSONP request)

  $auth = new \SOPx\Auth\V1_1\Client('<APP_ID>', '<APP_SECRET>');

  $request = $auth->createRequest(
    'GET',
    'https://<API_HOST>/path/to/jsonp/endpoint',
    array(
      'param1' => 'foo',
      'param2' => 'bar',
      ...
    )
  );

  // Then maybe in your HTML template:
  <script src="<?php echo $request->getUri(); ?>"></script>

Sending various request types

GET

  $request = $auth->createRequest('GET', (string) $url, (array) $params)

POST

For type application/x-www-form-urlencoded, _(*5)

  $request = $auth->createRequest('POST', (string) $url, (array) $params)

For type application/json, _(*6)

  $request = $auth->createRequest('POSTJSON', (string) $url, (array) $params)

DELETE

  $request = $auth->createRequest('DELETE', (string) $url, (array) $params)

PUT

For type application/x-www-form-urlencoded, _(*7)

  $request = $auth->createRequest('PUT', (string) $url, (array) $params)

For type application/json, _(*8)

  $request = $auth->createRequest('PUTJSON', (string) $url, (array) $params)

Verifying a request signature for validity

  $auth = new \SOPx\Auth\V1_1\Client('<APP_ID>', '<APP_SECRET>');

  $sig = $params['sig'];
  unset($params['sig']);

  if ($auth->verifySignature($sig, $params)) {
    // Request is valid
  }
  else {
    // Request is invalid
  }

request types defined in SOP v1.1 Authentication., _(*9)