PHPackages                             rusadrako/api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. rusadrako/api

ActiveLibrary[API Development](/categories/api)

rusadrako/api
=============

API

3.2.0(1y ago)049MITPHPPHP >=7.0.0

Since Mar 13Pushed 1y ago1 watchersCompare

[ Source](https://github.com/RusaDrako/api)[ Packagist](https://packagist.org/packages/rusadrako/api)[ RSS](/packages/rusadrako-api/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (5)DependenciesVersions (9)Used By (0)

RusaDrako\\api
==============

[](#rusadrakoapi)

[![Version](https://camo.githubusercontent.com/ac477d63d443749eb9ebe6c56e291c33c0056fcb696240f6d72b5c8726e047b1/687474703a2f2f706f7365722e707567782e6f72672f727573616472616b6f2f6170692f76657273696f6e)](https://packagist.org/packages/rusadrako/api)[![Total Downloads](https://camo.githubusercontent.com/415eb6cd28ebda9d92e3055bcfbb04173b52dd40ec1545cb27aac10f0b5ccacb/687474703a2f2f706f7365722e707567782e6f72672f727573616472616b6f2f6170692f646f776e6c6f616473)](https://packagist.org/packages/rusadrako/api/stats)[![License](https://camo.githubusercontent.com/1c3196961648b44026263500492bc02ae63f515a3343e736cb8263ab087ce9e5/687474703a2f2f706f7365722e707567782e6f72672f727573616472616b6f2f6170692f6c6963656e7365)](./LICENSE)

Набор классов для организации API

Установка (composer)
--------------------

[](#установка-composer)

```
composer require 'rusadrako/api'
```

Установка (manual)
------------------

[](#установка-manual)

- Скачать и распоковать библиотеку.
- Добавить в код инструкцию:

```
require_once('/api/src/autoload.php')
```

Аутентификация внешнего подключения
-----------------------------------

[](#аутентификация-внешнего-подключения)

```
use RusaDrako\api\ClientApi;
use RusaDrako\api\ExceptionClientApi;
use RusaDrako\api\ExceptionToken;

# Уникальный ключ соединения
$key = '0123456789ABCDEF';
# Активация объекта
$apiClient = new ClientApi($key);

# Входящий токен
$token = $_POST['token'];
# Входящий массив данных для проверки токена
$token_data = [
    $_POST['date'],
    $_POST['add_data'],
    ...
];

try {
    # Проверка аутентификации
    $apiClient->auth($token, ...$token_data);
} catch (ExceptionClientApi $e) {
    # Возвращаем ошибку аутентификации
    $apiClient->get_result()->error($e->getCode, $e->getMessage());
} catch (ExceptionToken $e) {
    # Возвращаем ошибку генерации токена
    $apiClient->get_result()->error($e->getCode, $e->getMessage());
}
/* Обработка данных */
# Возвращаем результата
$apiClient->get_result()->result('Ок');
```

Класс ClientApi
---------------

[](#класс-clientapi)

Базовый клас для организации API

```
use RusaDrako\api\ClientApi;

# Уникальный ключ соединения
$key = '0123456789ABCDEF';

$apiClient = new ClientApi($key);
```

#### Метод auth()

[](#метод-auth)

Проверяет подлинность токена

```
/** @var ClientApi $apiClient */
$auth = $apiClient->auth($token, ...$token_data);
```

- **$token** - входящий токен
- **...$token\_data** - массив данных для проверки токена используемый объектом `RusaDrako\api\Token`

Метод возвращает `true` или прерывает выполнение кода и выводит json-сообщение об ошибке.

#### Метод generate\_token()

[](#метод-generate_token)

Генерирует токен. Возвращает `Токен` или прерывает выполнение скрипта и выводит json-сообщение об ошибке.

```
/** @var ClientApi $apiClient */
$token = $apiClient->generate_token(...$token_data);
```

- **...$token\_data** - массив данных для проверки токена используемый объектом `RusaDrako\api\Token`

#### Метод set\_token()

[](#метод-set_token)

Задаёт новый объект генерации токена.

```
/** @var ClientApi $apiClient */
$apiClient->set_token($obj_token);
```

- **$obj\_token** - объект генерации токена реализующий интерфейс `RusaDrako\api\_inf_token`

#### Метод get\_token();

[](#метод-get_token)

Возвращает объект генерации токена.

```
/** @var ClientApi $apiClient */
$obj_token = $apiClient->get_token();
```

#### Метод set\_result()

[](#метод-set_result)

Задаёт новый объект вывода результата.

```
/** @var ClientApi $apiClient */
$apiClient->set_result($obj_result);
```

- **$obj\_result** - объект вывода результата наследующий класс `RusaDrako\api\Result`

#### Метод get\_result()

[](#метод-get_result)

Возвращает объект вывода результата.

```
/** @var ClientApi $apiClient */
$result_obj = $apiClient->get_result();
```

Класс Token
-----------

[](#класс-token)

Класс формирования токена API. Можно назначить свой токен

```
use RusaDrako\api\Token;
$result_obj = new Token($key);
```

- **$key** - секретный ключ.

#### Метод generate()

[](#метод-generate)

Генерирует токен

```
$datetime = '2023-01-01 15:00:00';
$requiredParameter = '';
$notRequiredParameter = '';
...
/** @var Token $token_obj */
$token = $token_obj->generate($datetime, $requiredParameter, $notRequiredParameter, ...);
```

- **$datetime** - контрольное время, относительно которого расчитывается токен. Время токена не должно отличаться от текущего время больше чем на +/-10 минут.
- **$requiredParameter** - обязательные параметр (отсутствие вызывает ошибку). Обязательный параметр не должен быть пустым.
- **$notRequiredParameter** - необязательные параметры (любое количество) (отсутствие не вызывает ошибку).

Класс Result
------------

[](#класс-result)

Класс формирования ответа API

```
use RusaDrako\api\Result;
$result_obj = new Result();
```

#### Метод result()

[](#метод-result)

Формирует и выводит ответ для API

```
/** @var Result $result_obj */
$result_obj->result($answerData);
```

- **$answerData** - данные для ответа

#### Метод error()

[](#метод-error)

Формирует и выводит ответ для API с ошибкой

```
/** @var Result $result_obj */
$result_obj->error($errCode, $errMessage);
```

- **$errCode** - код ошибки
- **$errMessage** - сообщение об ошибке

Варианты формирования ответов
-----------------------------

[](#варианты-формирования-ответов)

#### Ответ с данными

[](#ответ-с-данными)

```
/** @var ClientApi $apiClient */
$apiClient->get_result()->result("");
```

```
{"ok":true,"result":""}
```

#### Ответ с массивом данных

[](#ответ-с-массивом-данных)

```
/** @var ClientApi $apiClient */
$apiClient->get_result()->result(['key_1'=>'Текст 1','key_2'=>'Текст 2']);
```

```
{"ok":true,"result":{"key_1":"Текст 1","key_2":"Текст 2"}}
```

#### Ответ с ошибкой

[](#ответ-с-ошибкой)

```
/** @var ClientApi $apiClient */
$apiClient->get_result()->error("", "");
```

```
{"ok":false,"result":null,"errCode":"","errMessage":""}
```

License
-------

[](#license)

Copyright (c) Petukhov Leonid. Distributed under the MIT.

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance42

Moderate activity, may be stable

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~202 days

Recently: every ~308 days

Total

8

Last Release

477d ago

Major Versions

1.0.2 → 2.0.02021-09-13

2.0.1 → 3.0.02023-12-11

### Community

Maintainers

![](https://www.gravatar.com/avatar/dfa89c28184b3c77d819628f24225e78de8e969601e1ff1066a5f4bf5b46491d?d=identicon)[RusaDrako](/maintainers/RusaDrako)

---

Top Contributors

[![RusaDrako](https://avatars.githubusercontent.com/u/32844979?v=4)](https://github.com/RusaDrako "RusaDrako (26 commits)")

### Embed Badge

![Health badge](/badges/rusadrako-api/health.svg)

```
[![Health](https://phpackages.com/badges/rusadrako-api/health.svg)](https://phpackages.com/packages/rusadrako-api)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)