Ahmad Awais

NAVIGATE


SHARE


Open Sourcing My Sendy PHP API Wrapper

Ahmad AwaisAhmad Awais

I recently started using Sendy.co (aff) to send emails. I was having trouble finding a good API wrapper for it. Spent more than five hours searching for one and ended up building one myself. I hope it helps.

šŸš€ GITHUB: ā˜… 60 ā‘‚ 17 ā†’#

šŸš€ Sendy PHP API Wrapper: Complete API interfacing.

[![emoji-log](https://cdn.rawgit.com/ahmadawais/stuff/ca97874/emoji-log/flat-round.svg)](https://github.com/ahmadawais/Emoji-Log/)

šŸ“Ø SENDY API#

With this Sendy PHP API Wrapper you can do the following:

SUBSCRIBERS LISTS CAMPAIGNS
Subscribe Set List Create
Unsubscribe Get List Draft
Delete subscriber Active subscriber count Send
Subscription status List Segments handling Assign to brands

Getting Started#

Getting started is easy. Here’s how you do it. You can check the example.php file as well. Obviously, you’ll have to download the wrapper to your current setup. Several ways to do that.

#1 MANUAL INSTALL:#

Git clone this repo and include ./src/Sendy.php in your project.

#2 COMPOSER INSTALL:#

Composer Install is the preferred method.

composer require ahmadawais/sendy-php-api

Step 0. Require the wrapper#

// New way using PSR4 Standard autoloader. Recommended
require_once . '/vendor/autoload.php';

// Old way of requiring all files manually. Not recommended.
require_once( 'API.php' );

Step 1. Configure it#

// 2. Configuration.
$config = [
    'sendyUrl' => 'https://send_installation_url.com', // Your Sendy installation URL (without trailing slash).
    'apiKey'   => 'XXXXXXXXXXXXXXXX', // Your API key. Available in Sendy Settings.
    'listId'   => 'XXXXXXXXXXXXXXXX',
];

Step 2. Init#

use AhmadAwais\Sendy\API as Sendy;

$sendy = new Sendy( $config );

API KEY METHODS#

  1. Method: subscribe().
  2. Method: unsubscribe().
  3. Method: subStatus().
  4. Method: delete().
  5. Method: subCount().
  6. Method: campaign().

Method #1: Subscribe#

// Method #1: Subscribe.
$responseArray = $sendy->subscribe(
    [
        'email'     => '[email protected]', // This is the only field required by sendy.
        'name'      => 'Name', // User name (optional).
        'custom'    => 'Field Value', // You can custom fields as well (optional).
        'country'   => 'US', // User 2 letter country code (optional).
        'ipaddress' => 'XX.XX.XX.XXX', // User IP address (optional).
        'referrer'  => 'https://AhmadAwais.com/', // URL where the user signed up from (optional).
        'gdpr'      => true, // GDPR compliant? Set this to "true" (optional).
    ]
);

Method #2: Unsubscribe#

$responseArray = $sendy->unsubscribe( '[email protected]' );

Method #3: Subscriber Status#

$responseArray = $sendy->subStatus( '[email protected]' );

Method #4: Delete Subscriber#

$responseArray = $sendy->delete( '[email protected]' );

Method #5: Subscriber Count of a list#

$responseArray = $sendy->subCount();

Method #6: Campaign ā€” Draft And/Or Send as well#

// Method #6: Campaign ā€” Draft And/Or Send as well.
$responseArray = $sendy->campaign(
    array(
        'from_name'            => 'Your Name',
        'from_email'           => '[email protected]',
        'reply_to'             => '[email protected]',
        'title'                => 'Title', // the title of your campaign.
        'subject'              => 'Your Subject',
        'plain_text'           => 'An Amazing campaign', // Optional.
        'html_text'            => '<h1>Amazing campaign</h1>',
        'brand_id'             => 1, // Required only if you are creating a 'Draft' campaign. That is `send_campaign` set to 0.
        'send_campaign'        => 0, // SET: Draft = 0 and Send = 1 for the campaign.
        // Required only if you set send_campaign to 1 and no `segment_ids` are passed in.. List IDs should be single or comma-separated.
        'list_ids'             => 'XXXXXXXX, XXXXXXXX',
        // Required only if you set send_campaign to 1 and no `list_ids` are passed in. Segment IDs should be single or comma-separated.
        'segment_ids'          => '1',
        // Lists to exclude. List IDs should be single or comma-separated. (optional).
        'exclude_list_ids'     => '',
        // Segments to exclude. Segment IDs should be single or comma-separated. (optional).
        'exclude_segments_ids' => '',
        'query_string'         => 'XXXXXXXX', // Eg. Google Analytics tags.
    )
);

Method #7: Set List ID#

// Method #7: Change the `XXXXXXX` you are referring to at any point.
$sendy->setListId( 'XXXXXXX' );

Method #8: Get List ID#

// Method #7: Get the `XXXXXXX` you are referring to at any point.
$sendy->getListId();

Response#

The response of this PHP wrapper is custom-built. At the moment, it always returns a PHP Array. This array has the status of your action and an appropriate message in the response.

    // E.g. SUCCESS response.
    [
        'status'  => true,
        'message' => 'Already Subscribed'
    ];

    // E.g. FAIL response.
    [
        'status'  => false,
        'message' => 'Some fields are missing.'
    ];

šŸ“

Changelog#

āÆ Read the changelog here ā†’

KEY: šŸ“¦ NEW, šŸ‘Œ IMPROVE, šŸ› FIX, šŸ“– DOC, šŸš€ RELEASE, and āœ… TEST

I use Emoji-log, you should try it and simplify your git commits.

šŸ“ƒ

License & Conduct#

šŸ™Œ

Connect#

GitHub @AhmadAwais (follow) To stay up to date on free & open-source software

Twitter @MrAhmadAwais (follow) To get #OneDevMinute daily hot tips & trolls

YouTube AhmadAwais (subscribe) To tech talks & #OneDevMinute videos

Blog: AhmadAwais.com (read) In-depth & long form technical articles

LinkedIn @MrAhmadAwais (connect) On the LinkedIn profile y’all

šŸ‘Œ

Me (Ahmad Awais) and my incredible wife (Maedah Batool) are two engineers who fell in love with open source and then with each other. You can read more about me here. If you or your company use any of my projects or like what Iā€™m doing then consider backing me. I’m in this for the long run. An open-source developer advocate.

Ahmad on Twitter

Ahmad on Twitter

This also happens to be my first composer package, so yay! šŸŽ‰

Feedback is more than welcomed at GitHub.

I help businesses understand developers šŸ“Ÿ Currently recording Node.js CLI Automation Course šŸ‘Øā€šŸ« Edutainer at VSCode.pro šŸŽ© An award-winning open-source engineer and developer advocate šŸ¦Š Google Developers Expert for web šŸŒ³ Node.js foundation Community Committee member āœŒļø Author of various open-source dev-tools and software libraries used by millions of developers worldwide ā“¦ WordPress Core Developer šŸ“£ TEDx Speaker šŸ™Œ Leading developers and publishing technical content for over a decade šŸ˜‚ Self-confessed tech comedian cracking silly jokes in the JavaScript web and cloud communities šŸ’œ Loves his wife (Maedah) āÆ Learn more about Awais ā†£

Say šŸ‘‹ on Twitter @MrAhmadAwais | Subscribe to the Developers Takeaway!

šŸ“Ø

Developers Takeaway

Takeaway my professional opinion on open-source, developer relations, growing your business with family, and everything in between! Delivered to your inbox a couple of times every year. I'm even funny at times. I hate spam ā€” pinky-promise!

šŸ‘Øā€šŸ’»šŸ‘©ā€šŸ’» 115,834 Developers Already Subscribed