iprbooks/iprbooks-eor-sdk

IPR Books EOR SDK

v1.1 2020-10-27 10:00 UTC

Requires

• php: 5.3.* || 5.4.* || 5.5.* || 5.6.* || 7.0.* || 7.1.* || 7.2.* || 7.3.* || 7.4.*
• ext-curl: *
• ext-json: *

Requires (Dev)

• firebase/php-jwt: 5.0.0

MIT

• Andrey Cherkasov

README

API платформы «Сетевые ЭОР вузов» — специально разработанный сервис для интеграции информационных систем организаций с разделом «Сетевые ЭОР вузов» электронно-библиотечной системы ЭБС IPR BOOKS. Документация по API находится здесь.

Содержание:

1. Установка
2. Инициализация клиента API
3. Доступ к данным
   • Получение каталога ЭОР
   • Получение каталога издательств ЭОР
   • Получение переченя изданий в рамках указанного ЭОР

Установка

Простой и наиболее предпочтительный способ установки SDK - composer.

 "iprbooks/iprbooks-eor-sdk" : "dev-master"

Другой способ - скачать архив с исходным кодм master.zip или воспользоваться git clone и вручную добавить в проект.

git clone [e-mail]:iprbooks/iprbooks-eor-sdk.git

Инициализация клиента Api

Для инициализации клиента необходимы следующие параметры

Параметр	Описание
$clientId	Идентификатор клиента (получается вместе с ключевой фразой для получения JWT-токена).
$token	Ключ защиты данных для JWT-авторизации запросов, получается в личном кабинете

Пример

$clientId = 187;
$token = 'qdEEZBzAr!KV%Dq(WfNm]mNdLzn(m8{8';

$client = new Client($clientId, $token);

Доступ к данным

Доступ к метаданным позволяет посредством API получать информацию о книгах, доступных подписчику в рамках приобретенной подписки.

Получение каталога ЭОР

Получение списка ЭОР вузов: основной информации и информации о количестве публикаций. Атрибуты элемента коллекции доступны с помощью публичных методов определенных и описанных в Eor.php

Пример:

// инициализация клиента
$client = new Client($clientId, $token);

// создание объекта коллекции
$eorCollection = new EorCollection($client);

// выполнение запроса
$eorCollection->get();

// обращение к элементу коллекции по индексу
$title = $eorCollection->getItem(0)->getName();


// перебор элементов коллекции с помощью foreach
foreach ($eorCollection as $eor) {
    $title = $eor->getName();
}

Получение каталога издательств ЭОР

Каталог вузов-правообладателей контента в рамках указанного ЭОР. Атрибуты элемента коллекции доступны с помощью публичных методов определенных и описанных в University.php

Пример:

// инициализация клиента
$client = new Client($clientId, $token);

// создание объекта коллекции
$universitiesCollection = new UniversitiesCollection($client);

// выполнение запроса
$universitiesCollection->get($eorId);

// обращение к элементу коллекции по индексу
$pubHouse = $universitiesCollection->getItem(0)->getPubHouse();

// перебор элементов коллекции с помощью foreach
foreach ($universitiesCollection as $university) {
    $pubHouse = $university->getPubHouse();
}

Получение переченя изданий в рамках указанного ЭОР

Возвращает список доступных книг каталога ЭБС с учетом подписки организации и ссылку бесшовного перехода на книгу. Атрибуты элемента коллекции (книги) доступны с помощью публичных методов определенных и описанных в Book.php

Пример:

// инициализация клиента
$client = new Client($clientId, $token);

// создание и конфигурация  объекта коллекции
$booksCollection = new BooksCollection($client);
$booksCollection->setLimit(5)->setOffset(0);

// выполнение запроса
$booksCollection->get($eorId);

// обращение к элементу коллекции по индексу
$title = $booksCollection->getItem(0)->getTitle();

// получение ссылки бесшовного перехода
$link = $booksCollection->getItem(0)->getReadingLink();

// перебор элементов коллекции с помощью foreach
foreach ($booksCollection as $book) {
    $title = $book->getTitle();
}