Download the PHP package rusadrako/api without Composer
On this page you can find all versions of the php package rusadrako/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rusadrako/api
More information about rusadrako/api
Files in rusadrako/api
Informations about the package api
RusaDrako\api
Набор классов для организации API
Установка (composer)
Установка (manual)
- Скачать и распоковать библиотеку.
- Добавить в код инструкцию:
Аутентификация внешнего подключения
Класс ClientApi
Базовый клас для организации API
Метод auth()
Проверяет подлинность токена
- $token - входящий токен
- ...$token_data - массив данных для проверки токена используемый объектом
RusaDrako\api\Token
Метод возвращает true
или прерывает выполнение кода и выводит json-сообщение об ошибке.
Метод generate_token()
Генерирует токен. Возвращает Токен
или прерывает выполнение скрипта и выводит json-сообщение об ошибке.
- ...$token_data - массив данных для проверки токена используемый объектом
RusaDrako\api\Token
Метод set_token()
Задаёт новый объект генерации токена.
- $obj_token - объект генерации токена реализующий интерфейс
RusaDrako\api\_inf_token
Метод get_token();
Возвращает объект генерации токена.
Метод set_result()
Задаёт новый объект вывода результата.
- $obj_result - объект вывода результата наследующий класс
RusaDrako\api\Result
Метод get_result()
Возвращает объект вывода результата.
Класс Token
Класс формирования токена API. Можно назначить свой токен
- $key - секретный ключ.
Метод generate()
Генерирует токен
- $datetime - контрольное время, относительно которого расчитывается токен. Время токена не должно отличаться от текущего время больше чем на +/-10 минут.
- $requiredParameter - обязательные параметр (отсутствие вызывает ошибку). Обязательный параметр не должен быть пустым.
- $notRequiredParameter - необязательные параметры (любое количество) (отсутствие не вызывает ошибку).
Класс Result
Класс формирования ответа API
Метод result()
Формирует и выводит ответ для API
- $answerData - данные для ответа
Метод error()
Формирует и выводит ответ для API с ошибкой
- $errCode - код ошибки
- $errMessage - сообщение об ошибке
Варианты формирования ответов
Ответ с данными
Ответ с массивом данных
Ответ с ошибкой
License
Copyright (c) Petukhov Leonid. Distributed under the MIT.