roichamp/php-client

A PHP wrapper for the RoiChamp REST API

1.0.3 2021-05-20 14:01 UTC

Requires

• php: >= 5.4.0
• ext-curl: *
• ext-json: *

MIT

• Stanko Arsenijevic

• php
• api
• email marketing
• RoiChamp

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 [e-mail]

Client class

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

Client methods

Subscriber Upsert

$roichamp->upsertSubscriber([
    'email' => '[e-mail]',
    'first_name' => 'Roi',
    'last_name' => 'Champ',
    'phone' => '[phone]',
    'metaData' => [
        'source' => 'google'
    ],
])

Arguments

Params	Type	Required	Description
email	string	yes	Subscriber email address.
first_name	string	no	Subscriber first name.
last_name	string	no	Subscriber last name.
phone	string	no	Subscriber phone number.
metaData	array	no	Key-value custom meta data.

Subscriber Unsubscribe

$roichamp->unsubscribe('[e-mail]')

Arguments

Params	Type	Required	Description
email	string	yes	Subscriber email address.

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' => '[e-mail]',
    'params' => [
        'reset_url' => '...',
    ],
])

Arguments

Params	Type	Required	Description
identity	string	yes	Email identity.
email	string	yes	Subscriber email address.
params	array	no	Key-value custom email params.

Release History

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