accsm/reseller-api-sdk

There is no license information available for the latest version (v1.0.0) of this package.

SDK for accsmaster reseller api

v1.0.0 2023-06-30 16:56 UTC

Requires

• php: >=7.3
• ext-curl: *
• ext-fileinfo: *
• ext-json: *

Unknown License

README

Markdown output:

Accsmaster SDK

This is an official Accsmaster Reseller SDK. Out of the box it covers all endpoints and has the functionality to fully interact with API. This SDK can be used for development as it is, or serve as reference for you own SDK.

• API Reference

Table of contents

• Installation
• Getting started
• Order Statuses
• Methods
  • Authentication
    • Authenticate
    • Refresh
    • Invalidate
  • Object
    • Get Token
    • Get Secret
    • Set Token
    • Set Secret
  • Data
    • Offers
    • Offer
    • Categories
    • Orders
    • Order
    • User
  • Buy
• Callback

Installation

Installation via composer: composer require accsm/reseller-api-sdk

Manual installation:

1. Download archive
2. Unpack and add ResellerSDK to your project
3. Remove Accsm from namespace and path to where you put ResellerSDK folder and add your namespace

Getting started

There are only 4 files in this SDK:

• src/ResellerSDK/ResellerSDK.php - Contains all core code and logic
• index.php - File used for demonstration (you can delete it)
• callback_example.php - File used for demonstration (you can delete it)

Let's start with our first and only ResellerSDK class.

1. First of all, we need to create new object.

require 'src\ResellerSDK\ResellerSDK.php';
// and/or
use Accsm\ResellerSDK\ResellerSDK;

$api = new ResellerSDK();

1. Then authenticate with email and password, check if our credentials are correct, and then store token and user secret from auth data to your DB, file, config, etc.

$authData = $api->auth('[e-mail]', 'pass');

if (empty($success)) {
    throw new Exception('Wrong credentials');
}

$bearerToken = $authData['bearerToken'];
$userSecret = $authData['userSecret'];

// Store $userSecret & $bearerToken
// ...

1. Then we can make API requests with this object! You can see the list of all methods in Methods section.

$categories = $api->categories();
$offers = $api->offers(['product_id' => 4]);
$user = $api->user();

1. Next time you create an object of that class you can simply pass bearer token and user secret into the construct method.

$api = new ResellerSDK('token', 'secret'); 

Order statuses

• 1: new:
• 2: in_progress
• 3: complete
• 4: canceled
• 5: pending
• 6: refunded
• 7: mispaid

Methods

List of all methods:

• $api->auth(string $email, string $password): ?array

• $api->refresh(): ?string

• $api->invalidate(): bool

• $api->uesr(): array

• $api->categories(): array

• $api->offers(array $filters): array

• $api->orders(): array

• $api->order(string $orderNumber): array

• $api->buy(string $type, array $data)

• $api->getToken(): string

• $api->getSecret(): string

• $api->setToken(string $token): $this

• $api->setSecret(string $secret): $this

Authentication

Authenticate

Endpoint: https://accsmaster.com/api/v1/user/login
Method: $api->auth(string $email, string $password)
Params: string $email, string $password
Returns: ?array ['bearerToken' => 'token', 'userSecret' => 'secret'] or null

This method:

1. Attempts authentication on 'user/login' endpoint.
2. Stores bearer token to an object.

It is strongly suggested to store your token to the database, file or some other way and not to use this method every time when making requests.

Refresh

Endpoint: https://accsmaster.com/api/v1/user/refresh
Method: $api->refresh();
Returns: string (new token) or null

This method:

1. Refreshes token.
2. Replaces old token with a new one in an object.

Invalidate

Endpoint: https://accsmaster.com/api/v1/user/invalidate
Method: $api->refresh();
Returns: bool (invalidation successful or not)

This method:

1. Invalidates and deletes token from an object.

Object

Construct

Params: string $bearerToken = '', string $userSecret = ''

$api = new \Accsm\ResellerSDK\ResellerSDK($bearerToken, $userSecret);

Get Token

Method: $api->getToken()
Returns: string (token from an object)

This method:

1. Returns bearer token from an object.

Get Secret

Method: $api->getSecret()
Returns: string (secret from an object)

This method:

1. Returns user secret from an object.

Set Token

Method: $api->setToken(string $token)
Params: string $token Returns: $this

This method:

1. Sets bearer token to an object.

Set Secret

Method: $api->setSecret(string $secret)
Params: string $secret Returns: $this

This method:

1. Sets user secret to an object.

Data

User

Endpoint: https://accsmaster.com/api/v1/user
Method: $api->user();
Returns: array (current user)

This method:

1. Returns current user.

Offers

Endpoint: https://accsmaster.com/api/v1/offers
Method: $api->offers(array $data);
Params: Optional: [category_id => int, product_id => int, discount => bool]
Returns: array (offers)

This method:

1. Return offers with filters.

Offer

Endpoint: https://accsmaster.com/api/v1/offer
Method: $api->offer(int $id);
Params: int $id
Returns: array (offer)

This method:

1. Return offer by its id.

Categories

Endpoint: https://accsmaster.com/api/v1/categories
Method: $api->categories();
Returns: array (all categories)

This method:

1. Returns all categories.

Orders

Endpoint: https://accsmaster.com/api/v1/orders
Method: $api->orders();
Returns: array (user orders)

This method:

1. Return all user orders.

Order

Endpoint: https://accsmaster.com/api/v1/order
Method: $api->order(string $orderNumber);
Params: string $orderNumber
Returns: array (user order)

This method:

1. Return order by it's 'order_number'.

Buy

Endpoint: https://accsmaster.com/api/v1/buy
Method: $api->buy(string $type, array $data);
Returns: array (user order)

This method:

1. Creates order and does everything a simple order creation on website would do.

Params for types:

$type options:

1. 'offer'
2. 'review'
3. 'install'

'offer' type $data params:

• quantity: required|int
• offer_id: required|int
• callback_url: optional|string
• sandbox: optional|bool

'review' type $data params:

• quantity: required|int
• offer_id: required|int
• url: required|string
• reviews_array: optional|array
• reviews: optional|string
• file: optional|types:txt,doc,csv|max_size:6020
• callback_url: optional|string
• sandbox: optional|bool

'install' type $data params:

• quantity: required|int
• offer_id: required|int
• app_link: required|string
• app_id: required
• days: required|int
• country: required|array
• reviews: optional|string
• file: optional|types:txt,doc,csv|max_size:6020
• callback_url: optional|string
• sandbox: optional|bool

If 'file', 'reviews' or 'reviews_array' is empty, then reviews will be autogenerated. It is recommended to write your on reviews.

Params in $data explained:

• 'file': send reviews in file. They will be reviewed manually. Example: $data['file'] = realpath('') . '\' . 'test_data.txt;
• 'reviews': reviews should be divided by \n. Example: $data['reviews'] = 'review1 \n review2 \n review3';
• 'reviews_array': each review in new index. Example: $data['reviews_array'] = ['review1', 'review2', ...]
• 'url': url to place where to write reviews
• 'app_link': url to place where to make installs
• 'days': spread installations in this span of days
• 'country': ISO country code (US, RU, UA, etc.)
• 'sandbox': sandbox mode to make test orders. $data['sandbox'] = 1; for test orders.
• 'callback_url': your url endpoint to send order data to.

Callback

If you provide callback_url in buy method, Accsmaster will send you order data on order updates.

$response = [
  'number' => 'order_number',
  'status' => 'status_id',
  'total' => 'price',
  'secret_key' => 'secret_key'           
  'download_link' - 'link' // if needed
];

Call to you endpoint (your callback_url) will always have Signature header. This will allow you to be sure call is coming from Accsmaster. To check if it's valid you're going to need to:

1. Hash request data with your user secret with the following code:

function signCallbackData(string $secret, array $data)
{
    ksort($data);

    $string = '';

    foreach($data as $value) {
        if (in_array(gettype($value), ['array', 'object', 'NULL']) ){
            continue;
        }
        if(is_bool($value) && $value){
            $string .= 1;
        } else {
            $string .= $value;
        }
    }

    return hash_hmac('sha512', strtolower($string), $secret);
}

1. And then to check resulting hash against Signature header:

$json = file_get_contents('php://input');
$data = json_decode($json);
$headers = getallheaders();

$secret = 'my_secret';
$testSignature = signCallbackData($secret, $data);
$signature = $headers['Signature'];

if (!hash_equals($signature, $testSignature)) {
    // Error, wrong signature
    die;
}

// Process data
// ...