php-sdk

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 9 Open GitHub ↗

No description available.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Mindbox PHP SDK

PHP библиотека для упрощённого взаимодейтсвия вашего PHP приложения с API Mindbox. С полной документацией API Mindbox можно ознакомиться [здесь](https://developers.mindbox.ru/docs/v3).

## Начало работы

### Зависимости

* PHP версии 7.3 или выше
* [psr/log](https://github.com/php-fig/log)
* [ext-json](http://php.net/manual/ru/json.installation.php)
* [ext-simplexml](http://php.net/manual/ru/simplexml.installation.php)
* [ext-libxml](http://php.net/manual/ru/libxml.installation.php)
* [ext-curl](http://php.net/manual/ru/curl.installation.php) (опционально)

### Установка

Вы можете установить Mindbox SDK двумя способами: используя Composer или скачав архив. Первый способ предпочтительнее, так как позволяет обновить библиотеку одной командой.

#### Composer (рекомендуемый способ)

Mindbox PHP SDK можно установить с помощью менеджера зависимостей [Composer](https://getcomposer.org/), используя следующую команду:

```sh
composer require mindbox/sdk
```

Для установки Mindbox PHP SDK в проекты, которые работают на PHP версии >=5.6 и < 7.3 необходимо использовать версию 1.0.7. Для этого выполнить следующую команду:

```sh
composer require "mindbox/sdk:^1.0.7"

```

#### Установка вручную

1. [Скачайте архив](https://github.com/mindbox-cloud/php-sdk/releases/download/1.1.3/php-sdk.zip), содержащий исходный код проекта (включая зависимости).
2. Распакуйте в директорию вашего проекта.
3. Подключите автозагрузчик классов в начале вашего скрипта:

```php
require_once __DIR__ . '/path/to/mindboxSDK/vendor/autoload.php';
```

## Использование
Обязательные параметры конфигурации SDK:
- `{logsDir}` - директория для логов
- `{endpointId}` - уникальный идентификатор сайта/мобильного приложения/и т.п. Значение нужно уточнить у менеджера Mindbox.
- `{secretKey}` - секретный ключ, соответствующий endpointId. Значение нужно уточнить у менеджера Mindbox.
- `{domainZone}` домен API Mindbox, на который будут отправляться запросы

Опциональные параметры:
- `{timeout}` таймаут соединения http запроса (в секундах), опционально. По умолчанию 5 секунд.
- `{httpClient}` способ отправки запроса ("curl", "stream"), опционально. По умолчанию curl, если установлено расширение ext-curl, иначе stream.

### Инициализация SDK

```php
$logger = new \Mindbox\Loggers\MindboxFileLogger('{logsDir}');

$mindbox = new \Mindbox\Mindbox([
    'endpointId' => '{endpointId}',
    'secretKey' => '{secretKey}',
    'domainZone' => '{domainZone}',
    //'timeout' => '{timeout}',
    //'httpClient' => '{httpClient}',
], $logger);
```

Подробнее о конфигурации и инициализации SDK [здесь](docs/getting_started.md).

### Использование хелперов для стандартных операций

Для стандартных операций Mindbox реализован набор хелперов, упрощающий осуществление запросов.
Простой пример отправки запроса авторизации потребителя к Mindbox с использованием хелпера:

```php
$logger = new \Mindbox\Loggers\MindboxFileLogger('{logsDir}');

$mindbox = new \Mindbox\Mindbox([
    'endpointId' => '{endpointId}',
    'secretKey' => '{secretKey}',
    'domainZone' => '{domainZone}',
], $logger);

$customer = new \Mindbox\DTO\CustomerRequestDTO();
$customer->setEmail('test@test.ru');
$customer->setMobilePhone('77777777777');
$customer->setId('mindboxId', '1028');

try {
    $response = $mindbox->customer()
        ->authorize($customer, 'Website.AuthorizeCustomer')
        ->sendRequest();
    
    $requestBody = $response->getRequest()->getBody();
    $responseBody = $response->getBody();
} catch (\Mindbox\Exceptions\MindboxClientException $e) {
    echo $e->getMessage();
    return;
}
```

Подробнее об использовании хелперов SDK [здесь](docs/README.md#примеры-использования-sdk).

### Универсальные методы для отправки произвольных запросов

Запросы, для которых не реализованы хелперы, можно выполнить с помощью универсальных методов:

```php

$logger = new \Mindbox\Loggers\MindboxFileLogger('{logsDir}');

$mindbox = new \Mindbox\Mindbox([
    'endpointId' => '{endpointId}',
    'secretKey' => '{secretKey}',
    'domainZone' => '{domainZone}',
], $logger);

$operation = new \Mindbox\DTO\OperationDTO();

$customer = new \Mindbox\DTO\CustomerRequestDTO();
$customer->setEmail('test@test.ru');
$customer->setMobilePhone('77777777777');
$customer->setId('mindboxId', '1028');

$operation->setCustomer($customer);

try {
    $response = $mindbox->getClientV3()
        ->prepareRequest('POST', 'Website.AuthorizeCustomer', $operation, '', [], false)
        ->sendRequest();
    $requestBody = $response->getRequest()->getBody();
    $responseBody = $response->getBody();
} catch (\Mindbox\Exceptions\MindboxClientException $e) {
    echo $e->getMessage();
}
```

Подробнее об использовании универсальных методов SDK [здесь](docs/README.md#примеры-использования-sdk).

## Документация

Подробная документация библиотеки доступна по [ссылке](docs/README.md).

php-sdk

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README