starteed/crowdfunding

A PHP wrapper for Starteed Crowdfunding's API

v1.0.0 2017-09-26 09:31 UTC

Requires

• php: >=5.5.9
• php-http/discovery: ^1.1
• php-http/httplug: ^1.0
• php-http/message: ^1.0
• symfony/event-dispatcher: ^3.2

Requires (Dev)

• phpunit/phpunit: ~5.0

MIT

• Dario Tranchitella

• api
• client
• wrapper
• crowdfunding
• starteed

README

Official Starteed SELF PHP API wrapper: help to read public data of Starteed SELF campaigns.

Widely inspired by Sparkpost PHP API wrapper.

Still in alpha version.

Authentication is provided with API key: contact our support to get one.

Installation

Install Composer first

curl -sS https://getcomposer.org/installer | php

Starteed SELF requires a php-http client: we suggest Guzzle6.

composer require php-http/guzzle6-adapter

Next install the package.

composer require starteed/crowdfunding

Setting up a Request Adapter

Because of dependency collision, we have opted to use a request adapter rather than requiring a request library. This means that your application will need to pass in a request adapter to the constructor of the Starteed SELF Library (we chose HttpPlug). Please visit their repo for a list of supported clients and adapters. If you don't currently use a request library, you will need to require one and create a client from it and pass it along. The example below uses the GuzzleHttp Client Library.

A Client can be setup like so:

<?php

require_once __DIR__ . '/vendor/autoload.php';

use GuzzleHttp\Client;
use Starteed\SelfCrowdfunding;
use Http\Adapter\Guzzle6\Client as GuzzleAdapter;

$http_client = new GuzzleAdapter(new Client);
$starteed = new Crowdfunding($http_client, [
    'platform' => 'myplatform.starteed.com'
]);

?>

Localization

Localization is provided by Accept-Language header: you can pass a dash or underscore value (e.g.: it_IT or it-IT) or just the language ISO code in the configuration array.

$http_client = new GuzzleAdapter(new Client);
$starteed = new Crowdfunding($http_client, [
    'platform' => 'myplatform.starteed.com',
    'language' => 'en_US'
]);

Note that if the language locale is not available all the results will be translated with default language as fallback

Campaigns

Paginated results

/**
 * @var Starteed\Resources\CampaignResource[] $campaigns
 */
$campaigns = $starteed->campaigns()->all();

// Grabbing first element of the data array
$campaign = $campaigns()->data[0];

$campaign->translation->title
# My campaign title

$campaign->goal
# 15000

$campaign->currency
#{
#    "id": 1,
#    "code": "EUR",
#    "symbol": "€",
#    "label": "Euro"
#}

$campaign->currency->label
# Euro

Retrieve by ID

$campaign = $starteed->campaigns()->retrieve(1);

$campaign->translation->title
# My campaign title

$campaign->goal
# 15000

$campaign->duration
#{
#    "start": 1476264100,
#    "end": 1479427200,
#    "is_non_stop": false
#}

Rewards

Paginated results

/**
 * @var Starteed\Resources\RewardResource[] $rewards
 */
$rewards = $starteed->campaigns()->retrieve(1)->rewards->all();
    
// Grabbing first element of the data array
$reward = $campaigns()->data[0];

$reward->image
# "rewards/57fcce15a573a.jpg"

$reward->is_active
# true

$reward->estimated_shipping
# 1476662400

$reward->translation->description
# The reward description chosen by campaign admin

Retrieve by ID

$reward = $starteed->campaigns()->retrieve(1)->rewards()->retrieve(2);

$reward->amount
# 50

FAQs

Paginated results

/**
 * @var Starteed\Resources\FaqResource[] $faqs
 */
$faqs = $starteed->campaigns()->retrieve(1)->faqs->all();

// Grabbing first element of the data array
$faq = $faqs[0];

$faq->translation->question
# "Is this a question?"

$faq->translation->answer
# "It looks like it!"

Retrieve by ID

$faq = $starteed->campaigns()->retrieve(1)->faqs()->retrieve(2);

$faq->translation->question
# "Are donations deductible?"

$faq->translation->answer
# "Yes, of course: you will receive a receipt via email once the donation is confirmed!"

Donors

Paginated results

/**
 * @var Starteed\Resources\DonorResource[] $donors
 */
 $donors = $starteed->campaigns()->retrieve(1)->donors()->all();

// Grabbing first element of the data array
$donor = $donors[0];

$supporter->firstname
# "John"

$supporter->lastname
# "Doe"

Retrieve by ID

$donnor = $starteed->campaigns()->retrieve(1)->donors()->retrieve(2);

$donor->email
# "[e-mail]"