Download the PHP package igivefirst/igf-sdk-php without Composer

On this page you can find all versions of the php package igivefirst/igf-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of igivefirst/igf-sdk-php

Informations about the package igf-sdk-php

iGivefirst PHP SDK

This project contains the PHP SDK for the iGivefirst Donation API. It is distributed as a Composer package for easy access.

Sample Usage

iGivefirst REST Donation API

In order to use the iGivefirst Donation API, you must be PCI level 1 compliant

Getting Started

In order to use the iGivefirst Donation API, you will first need to register as a publisher on our website.

  1. SDK prequesites - in order to use the PHP SDK you will need the cURL extension compiled with OpenSSL support
  2. Register as a publisher - sign up at [https://www.igivefirst.mobi/join/publisher]()
  3. Request access - send an email to [email protected] with your account information and we'll get you set up for access
  4. Configure API keys - visit the API page [https://www.igivefirst.mobi/publisher/donation-api]() to get your API keys and configure whitelisted IP addresses.

Guids

Our API utizes business keys in the form of standard 36 character guids. These guids are created with-in our system and are unique. The main guids that are utilized:

Secure Rest Donation API

Obtaining a private key

Login as your publisher and click on the api link on the bottom left. From there you will be able to access all of the above guids mentioned. This also includes the two keys that are used to secure our system:

Authenticating requests using Rest API

Authenticating Requests Using the REST API

When accessing iGivefirst API using REST , you must provide the following items in your request so the request can be authenticated:

Request Elements

Authorization

The iGivefirst REST API uses the standard HTTPAuthorization header to pass authentication information.
The following is an example of the header:

The header consists of the Publisher API Key concatenated with the Signature.

The Signature computed from Base64( HMAC-SHA1( UTF-8-Encoded( StringToSign ), PublisherSecret ) ) where

StringToSign = 
    HTTPVerb + "\n" 
    MD5-HASH-OF-Content + "\n" +
    Content-Type + "\n" +
    Timestamp + "\n" + 
    CanonicalizedResourceURI

An Example of the StringToSign

POST\n
bc1153d10db6079ecfbe3c3dca023402\n
application/json\n
Thu, 15 Sep 2012 00:51:48 GMT\n
/donation

or

GET\n
\n
\n
Thu, 15 Sep 2012 00:51:48 GMT\n
/donation/5def4c5f-e318-471f-9ef7-05cc965233cd

or 

DELETE\n
\n
\n
Thu, 15 Sep 2012 00:51:48 GMT\n
/donation/5def4c5f-e318-471f-9ef7-05cc965233cd

The StringToSign is then used to build the Signature by

  1. UTF-8 encoding the StringToSign
  2. Calculating the HMAC-SHA1 of the StringToSign using your secret key
  3. Base64 encoding the resulting hash bytes, excluding any hex encoding of the hash

Once you have your Signature you create the Authorization header by contenating your Access Key and the Signature:

Authorization: IGF_HMAC_SHA1 59e680df-df0a-42c3-969a-800d35ca5684:frJIUN8DYpKDtOLCwo//yllqDzg=

White Listed IP Addresses

The production system only communicates to the IP addresses that you have listed during the setup of the API key.

Donation API Endpoint

The donation api is used to create, get or delete a donation.

Headers Used

HTTP Verbs

GET - Get a donation

Example

Response

POST - Create a donation for a donor

Example

Body

Response Success

Response Failure

DELETE - Cancel a donation

NOT YET IMPLEMENTED

Example

PUT - not implemented

Cancel the donation with DELETE and then POST to create new donation

Donor API Endpoint

The donation api is used to find, create, get, or delete a donor.

Headers Used

HTTP Verbs

GET - Find a donor

Example

Response

GET - Get a donor by guid

Example

Response

POST - Create a donor

Example

Body

Response

PUT - Update a donor

NOT YET IMPLEMENTED

Example

Body

DELETE

Not supported

Account API Endpoint

The account api is used to create or update donor accounts. The donor api above provides the only 'get' information for accounts.

Headers Used

HTTP Verbs

GET

Not supported, accessible through Donor API

POST - Create a donor account

Example

Body

Response

PUT - Update an account

Example

Body

Response

HTTP 200

DELETE - Disable an account

Example

Response

HTTP 202

All versions of igf-sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version >=5.3.3
guzzle/guzzle Version ~3.7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package igivefirst/igf-sdk-php contains the following files

Loading the files please wait ....