zera555/share-a-sale-api-client

PHP client for Share-A-Sale API

v1.2 2020-01-28 19:15 UTC

This package is not auto-updated.

Last update: 2022-05-19 05:18:56 UTC


README

Build Status License

Introduction

Zend Framework module to consume Share-A-Sale API

Installation

Install the module using Composer into your application's vendor directory. Add the following line to your composer.json.

{
    "require": {
        "zera555/share-a-sale-api-client": "1.*"
    }
}

Configuration

Enable the module in your application.config.php file.

return array(
    'modules' => array(
        'Zera555\ShareASale'
    )
);

Copy and paste the shareasale.local.php.dist file to your config/autoload folder and customize it with your credentials and other configuration settings. Make sure to remove .dist from your file.Your shareasale.local.php might look something like the following:

<?php
return [
    'shareasale_service' => [
        'service_url' => 'https://shareasale.com',
        'service_version' => '2.1',
        'affiliate_id' => '<affiliate-id>',
        'token' => '<token>',
        'secret_key' => '<secret-key>',
    ]
];

Usage

Calling from your code:

        use Zera555\ShareASale\Service\ShareASaleService;
        
        $service = new ShareASaleService();
        
        $options = [
            'dateStart' => '6/22/2016',
        ];
        
        $records = $service->activity($options);
        
        var_dump($records);
        

Using the console:

php public/index.php shareasale activity -v

Implemented Service Methods:

  • activity
  • activitySummary
  • merchantTimespan
  • dailyActivity
  • monthlySummary
  • voidtrail
  • traffic
  • apitokencount
  • getProducts
  • invalidLinks
  • orderInquiry
  • merchantDataFeeds
  • couponDeals
  • merchantStatus
  • merchantCreative
  • merchantGiftCard
  • edittrail
  • paymentSummary
  • merchantSearch
  • merchantSearchProduct
  • ledger
  • balance

Links