{"id":2041,"date":"2017-03-20T19:27:33","date_gmt":"2017-03-20T14:27:33","guid":{"rendered":"https:\/\/ahmadawais.com\/?p=2041"},"modified":"2023-08-16T05:47:17","modified_gmt":"2023-08-16T12:47:17","slug":"sendy-php-api-wrapper","status":"publish","type":"post","link":"https:\/\/ahmadawais.com\/sendy-php-api-wrapper\/","title":{"rendered":"Open Sourcing My Sendy PHP API Wrapper"},"content":{"rendered":"

I recently started using Sendy.co<\/a> (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.<\/p>\n

\n

\ud83d\ude80 GITHUB: \u2605 86 \u2442 21 \u2192<\/a>#<\/a><\/h2>\n<\/blockquote>\n
\n

<\/p>\n

\ud83d\ude80 Sendy PHP API Wrapper: Complete API interfacing.<\/p>\n

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

\ud83d\udce8 SENDY API#<\/a><\/h2>\n

With this Sendy PHP API Wrapper<\/code> you can do the following:<\/p>\n\n\n\n\n\n\n\n\n
SUBSCRIBERS<\/strong><\/th>\nLISTS<\/strong><\/th>\nCAMPAIGNS<\/strong><\/th>\n<\/tr>\n<\/thead>\n
Subscribe<\/td>\nSet List<\/td>\nCreate<\/td>\n<\/tr>\n
Unsubscribe<\/td>\nGet List<\/td>\nDraft<\/td>\n<\/tr>\n
Delete subscriber<\/td>\nActive subscriber count<\/td>\nSend<\/td>\n<\/tr>\n
Subscription status<\/td>\nList Segments handling<\/td>\nAssign to brands<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Getting Started#<\/a><\/h2>\n

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.<\/p>\n

#1<\/strong> MANUAL INSTALL:#<\/a><\/h3>\n

Git clone this repo and include .\/src\/Sendy.php<\/code> in your project.<\/p>\n

#2<\/strong> COMPOSER INSTALL:#<\/a><\/h3>\n

Composer Install is the preferred method.<\/p>\n

composer require ahmadawais\/sendy-php-api<\/code><\/pre>\n
Step 0. Require the wrapper#<\/a><\/h4>\n
\/\/ New way using PSR4 Standard autoloader. Recommended\nrequire_once . '\/vendor\/autoload.php';\n\n\/\/ Old way of requiring all files manually. Not recommended.\nrequire_once( 'API.php' );<\/code><\/pre>\n
Step 1. Configure it#<\/a><\/h4>\n
\/\/ 2. Configuration.\n$config = [\n    'sendyUrl' => 'https:\/\/send_installation_url.com', \/\/ Your Sendy installation URL (without trailing slash).\n    'apiKey'   => 'XXXXXXXXXXXXXXXX', \/\/ Your API key. Available in Sendy Settings.\n    'listId'   => 'XXXXXXXXXXXXXXXX',\n];<\/code><\/pre>\n
Step 2. Init#<\/a><\/h4>\n
use AhmadAwais\\Sendy\\API as Sendy;\n\n$sendy = new Sendy( $config );<\/code><\/pre>\n
API KEY METHODS#<\/a><\/h2>\n
    \n
  1. Method: subscribe()<\/code>.<\/li>\n
  2. Method: unsubscribe()<\/code>.<\/li>\n
  3. Method: subStatus()<\/code>.<\/li>\n
  4. Method: delete()<\/code>.<\/li>\n
  5. Method: subCount()<\/code>.<\/li>\n
  6. Method: campaign()<\/code>.<\/li>\n<\/ol>\n
    Method #1: Subscribe#<\/a><\/h3>\n
    \/\/ Method #1: Subscribe.\n$responseArray = $sendy->subscribe(\n    [\n        'email'     => 'your@email.com', \/\/ This is the only field required by sendy.\n        'name'      => 'Name', \/\/ User name (optional).\n        'custom'    => 'Field Value', \/\/ You can custom fields as well (optional).\n        'country'   => 'US', \/\/ User 2 letter country code (optional).\n        'ipaddress' => 'XX.XX.XX.XXX', \/\/ User IP address (optional).\n        'referrer'  => 'https:\/\/AhmadAwais.com\/', \/\/ URL where the user signed up from (optional).\n        'gdpr'      => true, \/\/ GDPR compliant? Set this to \"true\" (optional).\n    ]\n);<\/code><\/pre>\n
    Method #2: Unsubscribe#<\/a><\/h3>\n
    $responseArray = $sendy->unsubscribe( 'your@email.com' );<\/code><\/pre>\n
    Method #3: Subscriber Status#<\/a><\/h3>\n
    $responseArray = $sendy->subStatus( 'your@email.com' );\n<\/code><\/pre>\n
    Method #4: Delete Subscriber#<\/a><\/h3>\n
    $responseArray = $sendy->delete( 'your@email.com' );\n<\/code><\/pre>\n
    Method #5: Subscriber Count of a list#<\/a><\/h3>\n
    $responseArray = $sendy->subCount();<\/code><\/pre>\n
    Method #6: Campaign \u2014 Draft And\/Or Send as well#<\/a><\/h3>\n
    \/\/ Method #6: Campaign \u2014 Draft And\/Or Send as well.\n$responseArray = $sendy->campaign(\n    array(\n        'from_name'            => 'Your Name',\n        'from_email'           => 'your@email.com',\n        'reply_to'             => 'your@email.com',\n        'title'                => 'Title', \/\/ the title of your campaign.\n        'subject'              => 'Your Subject',\n        'plain_text'           => 'An Amazing campaign', \/\/ Optional.\n        'html_text'            => '<h1>Amazing campaign<\/h1>',\n        'brand_id'             => 1, \/\/ Required only if you are creating a 'Draft' campaign. That is `send_campaign` set to 0.\n        'send_campaign'        => 0, \/\/ SET: Draft = 0 and Send = 1 for the campaign.\n        \/\/ Required only if you set send_campaign to 1 and no `segment_ids` are passed in.. List IDs should be single or comma-separated.\n        'list_ids'             => 'XXXXXXXX, XXXXXXXX',\n        \/\/ Required only if you set send_campaign to 1 and no `list_ids` are passed in. Segment IDs should be single or comma-separated.\n        'segment_ids'          => '1',\n        \/\/ Lists to exclude. List IDs should be single or comma-separated. (optional).\n        'exclude_list_ids'     => '',\n        \/\/ Segments to exclude. Segment IDs should be single or comma-separated. (optional).\n        'exclude_segments_ids' => '',\n        'query_string'         => 'XXXXXXXX', \/\/ Eg. Google Analytics tags.\n    )\n);<\/code><\/pre>\n
    Method #7: Set List ID#<\/a><\/h3>\n
    \/\/ Method #7: Change the `XXXXXXX` you are referring to at any point.\n$sendy->setListId( 'XXXXXXX' );<\/code><\/pre>\n
    Method #8: Get List ID#<\/a><\/h3>\n
    \/\/ Method #7: Get the `XXXXXXX` you are referring to at any point.\n$sendy->getListId();<\/code><\/pre>\n
    Response#<\/a><\/h2>\n
    The response of this PHP wrapper is custom-built. At the moment, it always returns a PHP Array. This array has the status<\/code> of your action and an appropriate message<\/code> in the response.<\/p>\n