Авторизация

Авторизация осуществляется путем передачи параметра api-key  и api-login   в заголовках запроса.  

Чтобы получить параметры api-key  и api-login  для вашего аккаунта, обратитесь в техническую поддержку через чат или другим удобным способом.

URL для запросов

Отправка данных методом POST.

 https://go.ainox.pro/api/

Ответ на пустой запрос

При  правильно отправленных заголовках авторизации и пустом теле  запроса вы получите ответ:

{
    "result": "success",
    "message": "no request"
}

Управление заявками

Создание новой заявки

{
    "request":"request",
    "type":"add",
    "connector":"3f6ad43d89274e6",
    value:
        {
            "mail":"mail@mail.ru",
            "name":"Иванов Иван"
        }
}

Где значение:

• connector  – уникальный идентификатор коннектора (обязательно)
• value – идентификаторы основных полей в настройках коннектора, поля обязательные к заполнению в настройках коннектора обязательны к передаче и в запросе

Управление подписчиками

Вывод списка подписчиков

{
    "request":"subscriber",
    "type":"output",
    "limit": 0,
    "offset":0
}

Где значения:

• limit  – число строк в выборке (не обязательно)
• offset  – смещение относительно начала получаемого списка (не обязательно)

Вывод подписчика по ID

{
    "request":"subscriber",
    "type":"output",
    "id": 100
}

Где значение:

•  id   – идентификатор подписчика (обязательно)

Поиск подписчиков по E-mail

{
    "request":"subscriber",
    "type":"output",
    "search": {
        "mail":"mail@mail.ru"
    },
    "limit": 0,
"offset":0
}

Редактирование подписчика

{
    "request":"subscriber",
    "type":"edit",
    "id": 100,
    "value": 
        {
            "next_payment_date":"21.01.2021 15:00",
            "next_payment_price": 1000,
            "next_request_data":
                {
                    "description": "Оплата 5 лицензий по 200 RUB",
                },
        }
}

Где значения:

• id – идентификатор подписчика (обязательно)
• next_payment_date  – дата следующей оплаты 
• next_payment_price  - сумма следующей оплаты
• next_request_data - массив  полей, ключ массива должен быть равен имени  основного поля в настройках коннектора. При создании повторного счета его поля будут заполнены этими данными. 

Отписка

{
    "request":"subscriber",
    "type":"unsubscribe",
    "id": 100
}

Где значения:

• id  – идентификатор подписчика (обязательно)