Перейти к содержанию

Биллинг

Авторизация

Все запросы требуют API-ключ и номер проекта для авторизации. API-ключ можно посмотреть в настройках профиля.

Номер проекта можно передавать в URL запроса, например: https://cloud.roistat.com/api/v1/user/billing/transactions/list?project=12345

API-ключ можно передавать двумя способами:

  • Устанавливая HTTP-заголовок Api-key(рекомендуемый способ):

    Api-key: 1234567890qwerty
    
  • Добавляя параметр key в URL запроса (небезопасный способ):

    https://cloud.roistat.com/api/v1/user/billing/transactions/list?key=1234567890qwerty&project=12345
    

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

POST /user/billing/transactions/list

Метод возвращает список всех транзакций в рамках аккаунта.

В теле запроса можно использовать стандартные фильтры через массив filters.

Строка запроса:

POST https://cloud.roistat.com/api/v1/user/billing/transactions/list?project=12345

Тело запроса:

{
    "period": {
        "from": "2016-09-01T07:36:00.000Z",
        "to": "2016-09-29T07:36:00.000Z"
    }
}
{
    "data": [
        {
            "date": "2016-09-02T18:59:15+0000",
            "type": "charge",
            "system_name": null,
            "display_name": null,
            "project_id": null,
            "sum": 16.600000000000001,
            "balance": -16.600000000000001,
            "virtual_balance": 0
        },
        {
            "date": "2016-09-26T13:51:29+0000",
            "type": "topup",
            "system_name": "top_up_balance",
            "display_name": "Пополнение баланса",
            "project_id": null,
            "sum": 1000,
            "balance": 691.57000000000005,
            "virtual_balance": 0
        }
    ],
    "status": "success"
}

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
period object Период транзакций да
from string Начальная дата транзакций в формате 2016-09-01T07:36:00.000Z да
to string Конечная дата транзакций в формате 2016-09-29T07:36:00.000Z да
Параметр Тип Описание Обязательный
data array[object] нет
date string Дата операции нет
type string Тип операции: charge - списание, topup - пополнение нет
system_name null или string Системное название операции нет
display_name null или string Человекочитаемое название операции нет
project_id null или integer Номер проекта, если операции была применена к проекту нет
sum integer или number Сумма операции нет
balance integer или number Реальный баланс аккаунта после совершения операции нет
virtual_balance integer или number Виртуальный баланс аккаунта (т.е. бонусы от Roistat) после совершения операции нет
status string нет

Получить список всех транзакций в рамках аккаунта в формате Excel

POST /user/billing/transactions/list/export/excel

Данный метод аналогичен методу /user/billing/transactions/list, однако в ответ выдается файл Excel со списком транзакций для проекта.

Строка запроса:

POST https://cloud.roistat.com/api/v1/user/billing/transactions/list/export/excel?project=12345

Тело запроса:

{
    "period": {
        "from": "2016-09-01T07:36:00.000Z",
        "to": "2016-09-29T07:36:00.000Z"
    }
}

Файл в формате Excel

Строка запроса:

Параметр Тип Описание Обязательный
project string Номер проекта да

Тело запроса:

Параметр Тип Описание Обязательный
period object Период транзакций да
from string Начальная дата транзакций в формате 2016-09-01T07:36:00.000Z да
to string Конечная дата транзакций в формате 2016-09-29T07:36:00.000Z да

Без параметров.