Розробляйте з API AlwaysCompleted

Підключіть AlwaysCompleted до свого серверного процесу, щоб отримувати послуги, оформлювати замовлення та відстежувати їх виконання. Посібник проведе вас від першого запиту лише для читання до важливих перевірок під час створення замовлень. Тримайте відкритою довідку API з повними списками параметрів і прикладами відповідей.

Підготуйтеся до підключення

  1. Створіть акаунт і використайте його API-ключ у конфігурації свого сервера.
  2. Прочитайте каталог послуг та умови послуг, які плануєте пропонувати. Вимоги, доступні можливості й обмеження замовлень залежать від вибраної послуги.
  3. Надсилайте запити зі свого бекенду через HTTPS. Залишайте ввімкненою стандартну перевірку TLS-сертифікатів.
  4. Безпечно зберігайте API-ключ на своєму сервері. Не розміщуйте його на публічних сторінках, у браузерному JavaScript, на скриншотах або в спільних прикладах коду.

Виконайте перший запит лише для читання

Задокументована кінцева точка приймає POST-запити й повертає JSON. Офіційний приклад запиту використовує параметри форми в URL-кодуванні. Кожна дія містить ваш API-ключ і назву дії.

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

key=YOUR_API_KEY&action=services

Замінюйте заповнювач лише в конфігурації сервера. Дія services читає каталог і не створює замовлення. Використайте її відповідь, щоб визначити ID послуг і переглянути доступні поля перед створенням форми замовлення.

Використовуйте актуальні дані послуг і акаунта

Список послуг містить назву, тип, категорію, тариф, мінімальну й максимальну кількість, а також ознаки підтримки відновлення та скасування. Зіставте вибраний ID з актуальним описом і вимогами. Готуючи замовлення, використовуйте отримані дані, а не демонстраційні ID чи ціни з прикладів документації.

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

Обробляйте зміни кешованого каталогу

Оновлюючи кешований каталог, перевіряйте видалені ID, зміни цін і обмежень кількості перед повторним використанням збережених варіантів. Якщо вибраного ID немає в актуальній відповіді, призупиніть замовлення для перевірки, а не вибирайте послугу зі схожою назвою. Якщо тариф, тип або обмеження кількості змінилися, оновіть форму й повторно перевірте вибір перед надсиланням action=add. Збережіть перевірені дані послуги в локальному записі замовлення, щоб пізніше можна було встановити, що саме перевірив ваш застосунок.

Створюйте замовлення усвідомлено

Щоб створити замовлення, надішліть 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 для реселерів. Прочитайте Умови та політику разом з описом кожної послуги перед прийманням клієнтських замовлень.