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

Проекты

Авторизация

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

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

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

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

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

    https://cloud.roistat.com/api/v1/project/settings/counter/list?key=1234567890qwerty&project=12345
    

Получить список проектов, доступных пользователю

GET /user/projects

С помощью этого метода можно получить список проектов, доступных пользователю.

По параметру is_owner можно различать, в каких проектах пользователь является владельцем.

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

GET https://cloud.roistat.com/api/v1/user/projects

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

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

{
    "projects": [
        {
            "id": 111,
            "name": "project1",
            "profit": "0",
            "creation_date": "2016-09-01 07:55:11",
            "currency": "RUB",
            "is_owner": 1
        },
        {
            "id": 222,
            "name": "project2",
            "profit": null,
            "creation_date": "2017-08-08 14:47:29",
            "currency": "RUB",
            "is_owner": 1
        }
    ],
    "status": "success"
}

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

Параметр Тип Описание Обязательный
projects array[object] нет
id integer Номер проекта нет
name string Название проекта нет
profit null или string Доля прибыли в выручке проекта. Можно изменить в настройках проекта. нет
creation_date string Дата создания проекта нет
currency string Валюта проекта нет
is_owner integer Является ли пользователь владельцем проекта. 1 - если является, 0 - если не является. нет
status string нет

Создать новый проект

POST /account/project/create

С помощью этого метода можно создать новый проект.

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

POST https://cloud.roistat.com/api/v1/account/project/create

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

{
    "name": "Test",
    "currency": "RUB"
}
{
    "data": {
        "project_id": 123,
        "counter": {
            "id": "qwerty123456",
            "code": "<script>(function(w, d, s, h, id){w.roistatProjectId = id; w.roistatHost = h;})(window, document, 'script', 'cloud.roistat.com', 'qwerty123456');</scipt>"
        }
    }
}

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

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

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

Параметр Тип Описание Обязательный
name string Название нового проекта да
currency string Валюта проекта: "RUB" - российский рубль, "USD" - доллар США, "EUR" - евро, "UAH" - украинская гривна, "KZT" - казахстанский тенге, "BYN" - белорусский рубль, "BYR" - белорусский рубль (устаревший), "CHF" - швейцарский франк, "GBP" - британский фунт стерлингов, "CZK" - чешская крона, "AED" - дирхам ОАЭ. Название валюты должно быть указано только в виде латинского сокращения да
Параметр Тип Описание Обязательный
data object нет
project_id string Идентификатор созданного проекта нет
counter object Параметры счетчика созданного проекта нет
>> id string Уникальный ключ счетчика нет
>> code string JS код счетчика проекта нет

Получить код счетчика для проекта

POST /project/settings/counter/list

С помощью этого метода можно получить код счетчика для проекта.

Можно использовать как POST, так и GET метод.

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

POST https://cloud.roistat.com/api/v1/project/settings/counter/list?project=12345

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

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

{
    "data": [
        {
            "id": "qwerty123456",
            "code": "<script>(function(w, d, s, h, id){w.roistatProjectId = id; w.roistatHost = h;})(window, document, 'script', 'cloud.roistat.com', 'qwerty123456');</scipt>"
        }
    ]
}

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

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

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

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

Параметр Тип Описание Обязательный
data array[object] нет
id string Уникальный ключ счетчика проекта нет
code string JS код счетчика проекта нет