API

С помощью нашего API-сервиса, Вы сможете контролировать,а также автоматизировать работу личного кабинета и приобретаемых услуг.

Как это работает?

Необходимо запросить у администрации API-ключ, можете написать нам в Telegram: @CpaStore. После выдачи API-ключа, Вам будут доступны все методы, перечисленные ниже.

Важная памятка! Все ответы приходят в формате Json. И у всех ответов есть значение status по которому можно судить о состоянии ответа, успешный он, с ошибкой или иной, у каждого API метода расписан пласт выдаваемых им status, прочитайте про каждый, это поможет избежать ошибок в дальнейшем при использовании API




Проверка API-ключа

Метод для тестирования API-ключа, а также отображение списка прав.

GET / POST
apikey
Ключ доступа к API
v
Используемая версия API
https://cpastore.ru/api.check_token

status="success" - Ключ в рабочем состоянии, запрос составлен верно

status="error" - В запросе есть ошибки, смотрите error_id

status="ban" - Ключ был заблокирован за нарушение правил, смотрите ban_reason




Информация о балансе

Метод для получения инфорамции о состоянии баланса личного кабинета.

GET / POST
apikey
Ключ доступа к API
v
Используемая версия API
https://cpastore.ru/api.balance

status="success" - Запрос выполнен успешно

status="error" - В запросе есть ошибки, смотрите error_id




Список Ваших приложений

Метод для получения списка арендованных/купленных/забронированных приложений.

GET / POST
apikey
Ключ доступа к API
v
Используемая версия API
https://cpastore.ru/api.my_apps

status="success" - Запрос выполнен успешно

status="error" - В запросе есть ошибки, смотрите error_id

APP status="active" - Прилка активна

APP status="close" - Владение прилкой закрыто

APP status="unpaid" - Прилка неоплачена, владение закрыто

APP status="mark_fb" - Прилка помечена ФБ, владение закрыто

APP status="del_google" - Прилка удалена из GooglePlay, владение закрыто

APP status="google_moderate" - Прилка забронирована для Вас, Google модерирует её




Метод для получения списка созданных на приложении диплинков.

https://cpastore.ru/api.deeplinks

status="success" - Запрос выполнен успешно

status="error" - В запросе есть ошибки, смотрите error_id




Метод для создания диплинка для прилолжения.

https://cpastore.ru/api.deeplink_add

status="success" - Запрос выполнен успешно

status="error" - В запросе есть ошибки, смотрите error_id

status="confirm" - У системы к Вам вопрос, она требует подтверждение. Отправьте тот же самый запрос с confirm_hash-параметром, его значение Вам выслала система.




Список push-рассылок выбранного приложения

Метод для получения списка созданных на приложении push-рассылок.

GET / POST
apikey
Ключ доступа к API
appid
ID приложения
user
ID веба, чтобы показывать нужному вебу только его информацию
v
Используемая версия API
https://cpastore.ru/api.push

status="success" - Запрос выполнен успешно

status="error" - В запросе есть ошибки, смотрите error_id

PUSH status="wait" - Ждём времени когда нужно отправить Пуш

PUSH status="sending" - Идёт отправка пуша...

PUSH status="sended" - Пуш успешно отправлен

PUSH status="error" - Ошибка отправки пуша




Создание PUSH-рассылки

Метод для создания push-рассылки для прилолжения.

POST
apikey
Ключ доступа к API
appid
ID приложения
name
Название рассылки, от 2 до 40 симв.
user
ID веба, чтобы показывать нужному вебу только его информацию
title
Заголовок Push, от 2 до 50 симв.
text
Текст Push, от 2 до 100 симв.
image
Ссылка на изображение для Push
timer
Время когда нужно выполнить рассылку, формат Unix-Timestamp, часовой пояс по-умолчанию +3:00(Moscow)
channel
Кому отправить Push?
по DeepLink - HASH Диплинка нужен
по ГЕО - код страны нужен
v
Используемая версия API
https://cpastore.ru/api.push_add

status="success" - Запрос выполнен успешно

status="error" - В запросе есть ошибки, смотрите error_id




Архивация/Отмена Push-рассылки

Метод для архивации рассылки, если рассылка ещё не выполнялаксь, то она и не будет выполнена, будет отменена.

GET / POST
apikey
Ключ доступа к API
appid
ID приложения
hash
Хэш рассылки
v
Используемая версия API
https://cpastore.ru/api.push_archive

status="success" - Запрос выполнен успешно

status="error" - В запросе есть ошибки, смотрите error_id




Список Рекламных кабинетов FaceBook

Метод для получения списка прикреплённых к прилке рекламных кабинетов FaceBook.

GET / POST
apikey
Ключ доступа к API
appid
ID приложения
user
ID веба, чтобы показывать нужному вебу только его информацию
v
Используемая версия API
https://cpastore.ru/api.fbrk

status="success" - Запрос выполнен успешно

status="error" - В запросе есть ошибки, смотрите error_id

RK status="wait" - Система добавляет прилку в кабинет

RK status="copy" - Система ранее уже привязывала этот РК к приле

RK status="added" - РК ФБ привязан к приле

RK status="error" - РК ФБ не удалось привязать к приле




Шеринг прилки на рекламный кабинет FaceBook

Метод для шеринга РК ФБ к приле.

POST
apikey
Ключ доступа к API
appid
ID приложения
user
ID веба, чтобы показывать нужному вебу только его информацию
fbrk
Номер рекламного кабинета FaceBook (через запятую можно добавить сразу список РК)
callback
Ссылка которую откроет бот, когда внесёт в прилу РК. По 1 запуску на каждый РК. Переменные для ссылки: {FBRK} - номер РК, {USER} - веб, {STATUS_SHARE} - статус расшарки(success/copy/error).
Пример: Вы можете создать скрипт который будет получать от нас данные и уведомлять Вас когда система расшарит прилку на РК
v
Используемая версия API
https://cpastore.ru/api.fbrk_add

status="success" - Запрос выполнен успешно

status="error" - В запросе есть ошибки, смотрите error_id



Список error_id: появляется только при статусе = "error"

  • 1001 - Нет токена
  • 1002 - Нет метода
  • 1003 - апи ключ не существует
  • 1004 - нет доступа к этому методу
  • 1005 - невалидный appid/id прилки
  • 1006 - пустое название DeepLink
  • 1007 - Короткое название DeepLink
  • 1008 - Длинное название DeepLink
  • 1009 - Пустая ссылка
  • 1010 - Ссылка должна начинаться с http:// https://
  • 1011 - владение прилкой завершено, этот запрос выполнить нельзя
  • 1012 - не указали название рассылки
  • 1013 - Вы не указали заголовок Push
  • 1014 - Вы не указали текст Push
  • 1015 - Вы не указали время отправки Push
  • 1016 - Вы не указали кому отправить Push
  • 1017 - Слишком короткое название рассылки
  • 1018 - Слишком длинное название рассылки
  • 1019 - Слишком короткий заголовок рассылки
  • 1020 - Слишком длинный заголовок рассылки
  • 1021 - Слишком короткий текст рассылки
  • 1022 - Слишком длинный текст рассылки
  • 1023 - Нельзя выбрать этого получателя, диплинк с таким хешем несуществует!
  • 1024 - Ссылка на картинку Push должна начинаться с http:// https://
  • 1025 - Ссылка на картинку Push недоступна, она должна выдавать код ответа 200
  • 1026 - Картинку не удалось открыть, выберите другую
  • 1027 - Картинку должна быть в формате JPEG/PNG
  • 1028 - Картинка не должна быть больше 1024px в ширину или высоту. Попробуйте использовать картинку меньше
  • 1029 - Картинка не должна быть меньше 256px в ширину или высоту. Попробуйте использовать картинку больше
  • 1030 - Нельзя установить задачу на рассылку больше чем через 60 дней
  • 1031 - Время отправки пуша уже прошло, минимальный срок отправки пушей - через минуту
  • 1032 - В очереди одного приложения по API может быть не больше 50 задач на рассылку! Удалите ненужную задачу или дождитесь отправки одной из задач, чтобы создать новую.
  • 1033 - Невалидный хэш пуша
  • 1034 - Невалидный РКФБ