README

A PHP wrapper for the RoiChamp REST API. Easily interact with the RoiChamp REST API securely using this library.

Installation

composer require roichamp/php-client

Getting started

To get your API key contact us on office@roichamp.com

Client class

$roichamp = new \RoiChamp\Client([
    'token' => 'API_KEY'
]);

Client methods

Subscriber Upsert

$roichamp->upsertSubscriber([
    'email' => 'office@roichamp.com',
    'first_name' => 'Roi',
    'last_name' => 'Champ',
    'phone' => '+381123123',
    'metaData' => [
        'source' => 'google'
    ],
])

Arguments

Subscriber Unsubscribe

$roichamp->unsubscribe('office@roichamp.com')

Arguments

Category Upsert

$roichamp->upsertProduct([
    'identity' => '42141',
    'title' => 'Product title',
    'image' => '...',
    'permalink' => '...',
    'suggest' => 1,
    'metaData' => [
        'foo' => 'bar'
    ],
])

Product Upsert

$roichamp->upsertProduct([
    'identity' => '14214',
    'title' => 'Product title',
    'price' => 199,
    'price_promo' => 99,
    'currency' => 'USD',
    'image' => '...',
    'permalink' => '...',
    'content' => 'Product description',
    'suggest' => 1,
    'categoryIdentities' => ['42141'],
    'metaData' => [
        'foo' => 'bar'
    ],
])

Send transactional email

$roichamp->sendEmail([
    'identity' => 'reset_password',
    'to' => 'office@roichamp.com',
    'params' => [
        'reset_url' => '...',
    ],
])

Arguments

Release History

• 2021-04-26 - 1.0.0 - Pre-release.