README

A PHP SDK for GigWage

Supported PHP Versions: This SDK works with PHP 7.4.0+.

Installation

To install Composer

Globally in Mac

Download the latest version of Composer.

Run the following command in Terminal:

 $ php ~/Downloads/composer.phar --version

Run the following command to make it executable:

 $ cp ~/Downloads/composer.phar /usr/local/bin/composer
 $ sudo chmod +x /usr/local/bin/composer
 $ Make sure you move the file to bin directory.

To check if the path has /usr/local/bin, use
```
 $ echo $PATH
```
If the path is different, use the following command to update the $PATH:
```
 $ export PATH = $PATH:/usr/local/bin
 $ source ~/.bash_profile 
```
You can also check the version of Composer by running the following command:
```
 $ composer --version.       
```

Globally in Linux

Run the following command:

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

Run the following command to make the composer.phar file as executable:
```
 $ chmod +x composer.phar
```
Run the following command to make Composer globally available for all system users:
```
 $ mv composer.phar /usr/local/bin/composer
```

Windows 10

Download and run the Windows Installer for Composer.

Note: Make sure to allow Windows Installer for Composer to make changes to your php.ini file.
If you have any terminal windows open, close all instances and open a fresh terminal instance.
Run the Composer command.
```
 $ composer -V
```

Steps to install GigWage Package

To install the stable release, run the following command in the project directory:
```
  $ composer require bmcfarlin/gigwage-php-sdk
```
To install a specific release, run the following command in the project directory:
```
  $ composer require bmcfarlin/gigwage-php-sdk:1.0.0
```
Alternatively, you can download this source and run
```
  $ composer install
```

This generates the autoload files, which you can include using the following line in your PHP source code to start using the SDK.

<?php
require 'vendor/autoload.php'

Getting started

Authentication

To make the API requests, you need to create a Client and provide it with authentication credentials (which can be found at https://gigwage.com/).

We recommend that you store your credentials in the GIGWAGE_API_KEY, GIGWAGE_API_SECRET and the GIGWAGE_API_URL environment variables, so as to avoid the possibility of accidentally committing them to source control. If you do this, you can initialise the client with no arguments and it will automatically fetch them from the environment variables:

<?php
require 'vendor/autoload.php';
use GigWage\Client;

$client = new Client();

Alternatively, you can specifiy the authentication credentials while initializing the Client.

<?php
require 'vendor/autoload.php';
use GigWage\Client;

$client = new Client("your_api_key", "your_api_secret", "your_gigwage_url");

The Basics

The SDK uses consistent interfaces to create, retrieve, update, delete and list resources. The pattern followed is as follows:

<?php
$client->resources->create($params) # Create
$client->resources->get($id) # Get
$client->resources->update($id, $params) # Update
$client->resources->delete($id) # Delete
$client->resources->list() # List all resources, max 200 at a time

Also, using $client->resources->list() would list the first 200 resources by default (which is the first page, with size as 200, and page as 1). To get more, you will have to use size and page to get the second page of resources.

Examples

List Contractors

<?php
require 'vendor/autoload.php';
use GigWage\Client;

$client = new Client();
$json = $client->contractor->list();

Create a batch

<?php
require 'vendor/autoload.php';
use GigWage\Client;

$client = new RestClient();
$payments = [];
$json = $client->contractor->list();
$item = json_decode($json);
foreach($item->contractors as $contractor){
  $debit_card = false;
  $line_items = [['amount' => 15.00, 'reason' => 'Testing', 'reimbursement' => false]];
  $payment = ['contractor_id' => $contractor->id, 'debit_card' => $debit_card, 'line_items' => $line_items];
  $payments[] = $payment;
}
$data = ['payments' => $payments];
$data['nonce'] = hash('sha256', json_encode($data));
$json = $client->batch->create($data);

Transfer funds

<?php
require 'vendor/autoload.php';
use GigWage\Client;

$amount = 1000.00;
$direction = 'fund';
$data = ['amount' => $amount, 'direction' => $direction];
$data['nonce'] = hash('sha256', json_encode($data));
$json = $client->transfer->create($data);

Reporting issues

Report any feedback or problems with this version by opening an issue on Github.

bmcfarlin / gigwage-php-sdk

Maintainers

Details