dkdimitrov/wscapi

wsc api php package

1.0.1 2017-09-01 14:46 UTC

Requires

• php: >=5.6.4
• guzzlehttp/guzzle: 6.3.*

MIT

• Dragomir Dimitrov

README

This is a simple package to connect the WSC API and fetch taxa information.

Installation

Install the package via composer: composer require dkdimitrov/wscapi

Simple use:

Make an instance passing your Api key. Then fetch the taxon passing as an argument its lsid (digits only, not the whole string)

require 'vendor/autoload.php';

$wsc = new Wsc\Wsc\WscApi('yourApiKeyString');

$wsc->fetchSpecies('049542');

For Laravel users:

Register the ServiceProvider in config/app.php

        'providers' => [
		// [...]
                Wsc\Wsc\WscServiceProvider::class,
        ],

Then add your API Key to your .env file like this:

        WSC_API_KEY=yourApiKeyString

Usage

You can fetch family, genus or species information using one of the following methods:

$wsc->fetchFamily('0037');

$wsc->fetchGenus('01824');

$wsc->fetchSpecies('049542');

If the taxon status is SYNONYM you can fetch the valid one by calling this method with the link as an argument:

$species = $wsc->fetchSpecies('016759');

if($species->taxon->status == 'SYNONYM' || $species->taxon->status == 'HOMONYM_REPLACED'){
    $valid = $wsc->fetchValidTaxon($species->validTaxon->_href)
}

If you wish to fetch all or specific updated taxa for the given period, use the method below and pass the taxon type (optional) and starting date (optional). Valid values for type:

• family
• genus
• species

If no type is provided all types will be returned. Date should be in format 'YYYY-MM-DD'. The results from the date you provide to now will be returned. If you do not provide date the results from the last 6 months will be fetched.

$wsc->fetchUpdatedTaxa(null, 'YYYY-MM-DD');

$wsc->fetchUpdatedTaxa('species');

$wsc->fetchUpdatedTaxa('species', 'YYYY-MM-DD');