Download the PHP package iprbooks/iprbooks-ebs-sdk without Composer
On this page you can find all versions of the php package iprbooks/iprbooks-ebs-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package iprbooks-ebs-sdk
ЭБС IPR BOOKS PHP SDK
API ЭБС IPR BOOKS - RESTful API сервер, предназначенный для взаимодействия с информационными системами клиентов - подписчиков ЭБС IPR BOOKS. Документация по API находится здесь.
Содержание:
- Установка
- Инициализация клиента API
- Доступ к метаданным
- Получение коллекции книг
- Получение метаданных книги
- Получение коллекции периодических изданий
- Получение метаданных периодического издания
- Получение коллекции выпусков периодического издания
- Получение метаданных выпуска периодического издания
- Управление пользователями
- Получение текущего списка пользователей
- Получение пользователя и его метаданных
- Добавление пользователя
- Блокировка пользователя
- Восстановление пользователя
- Бесшовная интеграция
- Генерация ссылки на активацию ключа и авторизацию пользователя
- Создание ссылки для прохождения автоматической регистрации/аутентификации пользователя
Установка
Простой и наиболее предпочтительный способ установки SDK - composer.
Другой способ - скачать архив с исходным кодм master.zip или воспользоваться git clone и вручную добавить в проект.
Инициализация клиента Api
Для инициализации клиента необходимы следующие параметры
| Параметр | Описание |
|---|---|
| $clientId | Идентификатор организации-клиента ЭБС IPR BOOKS (получается вместе с ключевой фразой для получения JWT-токена). |
| $token | В личном кабинете ЭБС авторизоваться под главным пользователем организации, сгенерировать ключ защиты данных для JWT-авторизации запросов. |
Пример
Доступ к метаданным
Доступ к метаданным позволяет посредством API получать информацию о книгах и периодических изданиях, доступных подписчику
ЭБС IPR BOOKS в рамках приобретенной подписки.
Получение коллекции книг
Список полей для фильтрации с описанием доступен в
BooksCollection.php,
атрибуты элемента коллекции (книги) доступны с помощью публичных методов определенных и описанных в
Book.php
Пример:
Получение метаданных книги
Атрибуты книги доступны с помощью публичных методов определенных и описанных в
Book.php
Пример:
Получение коллекции периодических изданий
Список полей для фильтрации с описанием доступен в
JournalCollection.php,
атрибуты элемента коллекции (периодического издания) доступны с помощью публичных методов определенных и описанных в
Journal.php
Пример:
Получение метаданных периодического издания
Атрибуты книги доступны с помощью публичных методов определенных и описанных в
Journal.php
Пример:
Получение коллекции выпусков периодического издания
Список полей для фильтрации с описанием доступен в
IssuesCollection.php,
атрибуты элемента коллекции (выпуска) доступны с помощью публичных методов определенных и описанных в
Issue.php
Пример:
Получение метаданных выпуска периодического издания
Атрибуты книги доступны с помощью публичных методов определенных и описанных в
Issue.php
Пример:
Управление пользователями
Получение текущего списка пользователей
Список полей для фильтрации с описанием доступен в
UsersCollection.php,
атрибуты элемента коллекции (пользователя) доступны с помощью публичных методов определенных и описанных в
User.php
Пример:
Получение пользователя и его метаданных
Пример:
Добавление пользователя
Обязательно должны быть переданы следующие параметры:
- $email — email-адрес пользователя, длина не более 255 символов
- $fullname — полное имя пользователя
- $password — пароль пользователя
Необязательные параметры:
- $userType — тип пользователя. Список возможных значений доступен в User.php
Пример:
Блокировка пользователя
Блокировка пользователя организации по id
Пример:
Восстановление пользователя
Восстановление пользователя организации по id
Пример:
Бесшовная интеграция
Генерация ссылки на активацию ключа и авторизацию пользователя
Обязательные параметры:
- $userId - id пользователя организации
Необязательные параметры:
- $publicationId — проверяется существует ли данная публикация, если да, произойдет автопереход на страницу публикации
Пример:
Создание ссылки для прохождения автоматической регистрации/аутентификации пользователя
Обязательные параметры:
- $email — email пользователя, если он уже зарегистрирован, произойдет автоматическая авторизация данного пользователя
- $fullname - полное имя пользователя
- $userType - тип пользователя:
- 1 - студенты
- 2 - аспиранты
- 3 - преподаватели
- 4 - нетипизированный(по умолчанию)
- $publicationId - если передано, проверяется существует ли данная публикация, если да, произойдет автопереход на страницу публикации
- $openMethod - работает, если передан publication_id, значения true/false. Если параметр передан, проверит доступность издания, проверит возможность загрузки в iframe, если все проверки успешно пройдены, откроет ридер с загруженной публикацией.
Пример:
All versions of iprbooks-ebs-sdk with dependencies
ext-curl Version *
ext-json Version *