dkdimitrov/wscapi

1.0.1 2017-09-01 14:46 UTC

This package is not auto-updated.

Last update: 2024-09-24 17:49:28 UTC


README

这是一个简单的包,用于连接 WSC API 并获取物种信息。

安装

通过 composer 安装包:composer require dkdimitrov/wscapi

简单使用

创建一个实例,传入你的 API 密钥。然后通过传入其 lsid(仅数字,不是整个字符串)作为参数来获取分类

require 'vendor/autoload.php';

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

$wsc->fetchSpecies('049542');

对于 Laravel 用户

config/app.php 中注册 ServiceProvider

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

然后像这样将你的 API 密钥添加到 .env 文件中

        WSC_API_KEY=yourApiKeyString

用法

你可以使用以下方法之一获取科、属或物种信息

$wsc->fetchFamily('0037');

$wsc->fetchGenus('01824');

$wsc->fetchSpecies('049542');

如果分类状态为“同义词”,你可以通过调用此方法并传入链接作为参数来获取有效的分类

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

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

如果你希望获取给定时间段的所有或特定更新的分类,请使用以下方法,并传入分类类型(可选)和起始日期(可选)。类型的有效值

  • family
  • genus
  • species

如果没有提供类型,则返回所有类型。日期应格式为 'YYYY-MM-DD'。将返回从你提供的日期到现在的结果。如果不提供日期,则将获取过去6个月的结果。

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

$wsc->fetchUpdatedTaxa('species');

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