Перейти к основному содержимому

Управление группами

Группы - механизм группировки клиентских токенов для мобильных приложений и веб-сайтов.

Базовый адрес API — https://api.pushed.ru

Попробуйте в Swagger

Аутентификация​

Для всех методов используется аутентификация на основе Bearer токена, который можно получить в личном кабинете

Создание группы​

Адрес https://api.pushed.ru/v2/management/group | метод POST

Параметры запроса:

  • тело запроса:
{
  "operation": "Create",
  "name": "<groupName>",
  "type": "<groupType>",
  "clientTokens": [
    "<clientToken>"
  ]
}

Параметры тела запроса​

  • operation — Create - тип операции (обязательное поле)
  • name — Имя группы (обязательное поле)
  • type — Тип группы: "Mobile" (1) для мобильных приложений, "Web" (2) для веб-сайтов (обязательное поле). Можно использовать как строковое значение ("Mobile"/"Web"), так и числовое (1/2)
  • clientTokens — Массив клиентских токенов для добавления в группу (необязательное поле)

Пример запроса с использованием строкового значения типа:

curl -v -X POST https://api.pushed.ru/v2/management/group
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <accessToken>' 
-d '{ 
  "operation": "Create", 
  "name": "<groupName>", 
  "type": "Mobile",
  "clientTokens": [ "<clientToken>" ]
}'

Пример запроса с использованием числового значения типа:

curl -v -X POST https://api.pushed.ru/v2/management/group
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <accessToken>' 
-d '{ 
  "operation": "Create", 
  "name": "<groupName>", 
  "type": 1,
  "clientTokens": [ "<clientToken>" ]
}'

Примеры ответа:

В случае успеха:

{
  "model": {
    "groupId": "66d199c1885e451134479574",
    "notFoundClientTokens": null
  },
  "success": true,
  "message": null,
  "errCode": null
}

Изменение имени группы​

Адрес https://api.pushed.ru/v2/management/group | метод POST

Параметры запроса:

  • тело запроса:
{
  "operation": "Rename",
  "name": "<new_group_name>",
  "id": "<group_id>",
  "type": "<groupType>"
}

Параметры тела запроса​

  • operation — Rename - тип операции (обязательное поле)
  • name — Новое имя группы (обязательное поле)
  • id — Идентификатор группы (обязательное поле)
  • type — Тип группы: "Mobile" (1) для мобильных приложений, "Web" (2) для веб-сайтов (обязательное поле). Можно использовать как строковое значение ("Mobile"/"Web"), так и числовое (1/2)

Пример запроса:

curl -v -X POST https://api.pushed.ru/v2/management/group
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <accessToken>' 
-d '{ 
  "operation": "Rename", 
  "name": "<new_group_name>", 
  "id": "<group_id>",
  "type": "Mobile"
}'

Примеры ответа:

В случае успеха:

{
  "success": true,
  "message": null,
  "errCode": null
}

Удаление группы​

Адрес https://api.pushed.ru/v2/management/group | метод POST

Параметры запроса:

  • тело запроса:
{
  "operation": "Remove",
  "id": "<group_id>",
  "type": "<groupType>"
}

Параметры тела запроса​

  • operation — Remove - тип операции (обязательное поле)
  • id — Идентификатор группы (обязательное поле)
  • type — Тип группы: "Mobile" (1) для мобильных приложений, "Web" (2) для веб-сайтов (обязательное поле). Можно использовать как строковое значение ("Mobile"/"Web"), так и числовое (1/2)

Пример запроса:

curl -v -X POST https://api.pushed.ru/v2/management/group
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <accessToken>' 
-d '{ 
  "operation": "Remove", 
  "id": "<group_id>",
  "type": "Mobile"
}'

Примеры ответа:

В случае успеха:

{
  "success": true,
  "message": null,
  "errCode": null
}

Получить все клиентские токены по идентификатору группы​

Адрес https://api.pushed.ru/v2/management/client-token | метод POST

Параметры запроса:

  • тело запроса:
{
  "operation": "Get",
  "groupId": "<group_id>",
  "type": "<groupType>"
}

Параметры тела запроса​

  • operation — Get - тип операции (обязательное поле)
  • groupId — Идентификатор группы (обязательное поле)
  • type — Тип группы: "Mobile" (1) для мобильных приложений, "Web" (2) для веб-сайтов (обязательное поле). Можно использовать как строковое значение ("Mobile"/"Web"), так и числовое (1/2)

Пример запроса:

curl -v -X POST https://api.pushed.ru/v2/management/client-token
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <accessToken>' 
-d '{ 
  "operation": "Get", 
  "groupId": "<group_id>",
  "type": "Mobile"
}'

Примеры ответа:

В случае успеха:

{
  "model": [
    "3SFoZ0ShMPxDU5UaOjsluzinArYciMe1",
    "RBbUFdTVJfu2yig8BhpOx1HyEKiPwMxt",
    "zdT30MPjKtNULjP6l4nfZYtu7dnqvf9o"
  ],
  "success": true,
  "message": null,
  "errCode": null
}

Добавить клиентские токены в группу​

Адрес https://api.pushed.ru/v2/management/client-token | метод POST

Параметры запроса:

  • тело запроса:
{
  "operation": "Add",
  "groupId": "<groupId>",
  "type": "<groupType>",
  "clientTokens": [
    "<clientToken>"
  ]
}

Параметры тела запроса​

  • operation — Add - тип операции (обязательное поле)
  • groupId — Идентификатор группы (обязательное поле)
  • type — Тип группы: "Mobile" (1) для мобильных приложений, "Web" (2) для веб-сайтов (обязательное поле). Можно использовать как строковое значение ("Mobile"/"Web"), так и числовое (1/2)
  • clientTokens — Массив клиентских токенов для добавления в группу (обязательное поле)

Пример запроса:

curl -v -X POST https://api.pushed.ru/v2/management/client-token
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <accessToken>' 
-d '{ 
  "operation": "Add", 
  "groupId": "<group_id>", 
  "type": "Mobile",
  "clientTokens": [ "<clientToken>" ]
}'

Примеры ответа:

В случае успеха:

{
  "success": true,
  "message": null,
  "errCode": null
}

Удаление клиентских токенов из группы​

Адрес https://api.pushed.ru/v2/management/client-token | метод POST

Параметры запроса:

  • тело запроса:
{
  "operation": "Remove",
  "groupId": "<groupId>",
  "type": "<groupType>",
  "clientTokens": [
    "<clientToken>"
  ]
}

Параметры тела запроса​

  • operation — Remove - тип операции (обязательное поле)
  • groupId — Идентификатор группы (обязательное поле)
  • type — Тип группы: "Mobile" (1) для мобильных приложений, "Web" (2) для веб-сайтов (обязательное поле). Можно использовать как строковое значение ("Mobile"/"Web"), так и числовое (1/2)
  • clientTokens — Массив клиентских токенов для удаления из группы (обязательное поле)

Пример запроса:

curl -v -X POST https://api.pushed.ru/v2/management/client-token
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <accessToken>' 
-d '{ 
  "operation": "Remove", 
  "groupId": "<groupId>", 
  "type": "Mobile",
  "clientTokens": [ "<clientToken>" ]
}'

Примеры ответа:

В случае успеха:

{
  "success": true,
  "message": null,
  "errCode": null
}