Интеграция с API AlwaysCompleted

Подключите AlwaysCompleted к серверной части вашего приложения, чтобы получать список услуг, создавать заказы и отслеживать их выполнение. Это руководство проведёт вас от первого запроса на чтение данных до проверок, необходимых при создании заказов. Полные списки параметров и примеры ответов приведены в справочнике API.

Подготовьтесь к подключению

1. Создайте аккаунт и укажите его API-ключ в конфигурации серверной части приложения.
2. Изучите каталог услуг и условия услуг, которые планируете предлагать. Требования, доступные возможности и ограничения заказа зависят от выбранной услуги.
3. Отправляйте запросы со своего сервера по HTTPS. Оставьте стандартную проверку TLS-сертификатов включённой.
4. Храните API-ключ на сервере в защищённом месте. Не размещайте его на публичных страницах, в браузерном JavaScript, на скриншотах и в общедоступных примерах кода.

Выполните первый запрос на чтение данных

Указанный в документации адрес API принимает POST-запросы и возвращает JSON. В официальном примере запроса используются параметры формы с URL-кодированием. Каждый запрос содержит ваш API-ключ и название действия.

POST https://alwayscompleted.com/api/v2

key=YOUR_API_KEY&action=services

Замените значение-заглушку своим ключом только в серверной конфигурации. Действие services получает каталог и не создаёт заказ. Используйте ответ, чтобы определить ID услуг и изучить доступные поля перед разработкой формы заказа.

Используйте актуальные данные об услугах и аккаунте

Список услуг содержит название, тип, категорию, цену, минимальное и максимальное количество для каждой услуги, а также признаки поддержки восстановления и отмены. Сопоставляйте ID выбранной услуги с её актуальным описанием и требованиями. При подготовке заказа используйте полученные данные, а не примерные ID и цены из документации.

Запрос action=balance позволяет получить баланс аккаунта и его валюту. Суммы в справочнике служат примерами. Ваше приложение должно отображать фактический ответ и обрабатывать ошибки перед продолжением работы.

Проверяйте данные перед созданием заказа

Чтобы создать заказ, отправьте action=add с ID выбранной услуги и полями, обязательными для её типа. Для заказа типа Default используются link и quantity; у других типов набор параметров отличается. Перед отправкой проверьте соответствующий раздел справочника.

После успешного создания сохраните полученный ID заказа вместе с записью заказа в своей системе. Если время ожидания запроса истекло или результат неясен, проверьте его перед повторной отправкой. Повтор запроса add без проверки может создать нежелательный дубликат. Не используйте создание заказа для автоматической проверки подключения.

Отслеживайте заказы и доступные запросы по ним

Используйте action=status с параметром order для одного заказа или orders со списком ID через запятую для группы до 100 заказов. Документированный ответ содержит status, charge, start_count, remains и currency. Проверяйте каждый результат: в групповом ответе для отдельного ID может быть возвращена ошибка.

Восстановление и отмена доступны по запросу и зависят от условий выбранной услуги. Используйте action=refill для запроса восстановления, action=refill_status для проверки его статуса и action=cancel для запроса отмены. Описанные в документации групповые варианты принимают до 100 ID. Отправка запроса не гарантирует одобрения восстановления или отмены.

Продолжите интеграцию

Точные параметры действий и примеры приведены в полном справочнике API. Если вы разрабатываете сервис для работы с заказами клиентов, изучите раздел AlwaysCompleted для реселлеров. Перед приёмом заказов клиентов ознакомьтесь с условиями и правилами и описанием каждой услуги.