colada/europeana

欧洲数字图书馆API的客户端实现

1.0.1 2017-10-18 12:55 UTC

This package is not auto-updated.

Last update: 2024-09-22 08:31:05 UTC


README

Latest Version Software License Build Status Total Downloads

欧洲数字图书馆门户的PHP客户端库

这个PHP库提供了对欧洲数字图书馆REST API的高度抽象客户端实现。它允许您的PHP应用程序以高度抽象、开发人员友好的方式查询和检索通过主要欧洲数字图书馆门户发布的欧洲数字图书馆数据集。

什么是欧洲数字图书馆?

欧洲数字图书馆是一个互联网门户,充当着访问整个欧洲数字化的书籍、绘画、电影、博物馆物品和档案记录的接口。超过2000个欧洲机构做出了贡献。这些机构从著名的如荷兰国立博物馆、大英图书馆或卢浮宫到地区档案馆和当地博物馆。

安装

通过Composer

$ composer require colada/europeana

用法

API密钥

在连接到API端点之前,您需要API密钥。您可以在欧洲数字图书馆实验室网站上注册账户并获取密钥。

基本示例

执行基本搜索查询

$apiKey = "myRegisteredKey";
$payload = new Colada\Europeana\Payload\SearchPayload();
$payload->addQuery("Mona Lisa");

try
{
    $client = new Guzzle\Client()
    $apiClient = new Colada\Europeana\Transport\ApiClient($apiKey, $client);

    $payloadResponse = $apiClient->send($payload);

    $items = $payloadResponse->getItems();
    foreach ($items as $item) {
        $item->getTitle();
        $item->getType();
    }

} catch (new Colada\Europeana\Exception\EuropeanaException $e) {
    // Process the exception
}

功能

  • API调用被建模为 Payload -> Transport -> Response 类表示。
  • 响应使用 JMS Serializer 库反序列化为第一公民PHP对象。
  • 高度抽象的、松耦合的组件,便于在自己的应用程序中重用。

文档

目前这些API调用完全或部分实现了

如果您对API的操作有任何特定问题,请参阅欧洲数字图书馆API Google Group

测试

$ phpunit

贡献

有关详细信息,请参阅CONTRIBUTING

安全性

如果您发现任何安全问题,请通过电子邮件matthias@colada.be报告,而不是使用问题跟踪器。

致谢

本软件包深受Slack API库(由Cas Leentfaar编写)的启发。部分Slack API代码在MIT许可条款下重用和修改。

许可证

MIT许可证(MIT)。请参阅许可证文件获取更多信息。