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

Для начала работы вам нужно создать аккаунт на основном сайте QubiPay. Сразу после подтверждения указанного e-mail касса будет отправлена на согласование. На данном этапе Вы уже можете получить секретный ключ и установить прочие параметры в разделе "Технические настройки" личного кабинета.

В примерах данной документации используются следующие данные:

  • Идентификатор кассы: 5fead72e6c6eb9004990e29b
  • Секретный ключ: secret-key

# Готовые решения

Для упрощения процесса интеграции Вы можете использовать одну из следующих официальных библиотек:

# Базовый адрес

URL-адрес формируется по принципу https://gateway.qubipay.io/api/<версия API>/<метод>. Например, для метода Payments/create в последней версии API это будет https://gateway.qubipay.io/api/v1/Payments/create.

# Авторизация

Авторизация для доступа к непубличным методам API производится путём передачи заголовка Authorization с значением <идентификатор кассы>:<секретный ключ> в формате Base64.

Пример заголовка:

Authorization: Basic NWZlYWQ3MmU2YzZlYjkwMDQ5OTBlMjliOnNlY3JldC1rZXk=

# Поддерживаемые форматы данных

API поддерживает GET и POST запросы. GET запросы передают данные при помощи строки параметров запроса (query string или GET-параметры). POST запросы передают данные через тело запроса в формате application/json, application/x-www-form-urlencoded или multipart/form-data.

Важно! API всегда возвращает ответ в формате JSON, независимо от типа запроса.

# Тестирование

При использовании SDK тестовый режим включается как показано ниже:

// Инициализация клиента API
$paysys = new QubiPay('5fead72e6c6eb9004990e29b', 'secret-key');
// Включение тестового режима
$paysys->test_mode = true;
// Инициализация клиента API
const paysys = new QubiPay('5fead72e6c6eb9004990e29b', 'secret-key');
// Включение тестового режима
paysys.testMode = true;

При ручной реализации для тестирования в каждом запросе к API нужно указывать GET-параметр test с истинным (true или 1) значением. Например, https://gateway.qubipay.io/api/v1/Payments/create?test.

Примечание

По-умолчанию GET-параметр считается истинным, если он перечислен без явного указания значения, как было показано в примере.

Последнее изменение: 3 месяцев назад