Руководство

Введение

Боковая панель слева содержит ссылки на соответствующие разделы:

  • Имя пользователя - ссылки на личный профиль.
  • Панель управления - просмотр текущего статуса в виде диаграмм и графиков.
  • Приложения - управление приложением.
  • Коды разблокировки - автоматически сгенерированные или загруженные вами коды разблокировки.
  • Платежи - история входящих платежей пользователей.
  • Руководство - это руководство пользователя.

Панель управления

Вы можете установить общие фильтры для всех виджетов на панели управления:

  • Валюта - валюта, в которую будут конвертированы входящие и исходящие суммы на панели управления.
  • Период - период времени, за который данные отображаются в диаграммах и таблицах на панели управления. Определяет интервал, в течение которого анализируется и отображается информация и статистика о платежах, приложениях и других параметрах.

Баланс

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

В этом блоке отображаются следующие суммы:

  • Брутто: общий объём всех платежей пользователей за выбранный период до вычета комиссий.
  • Нетто: общая сумма всех платежей за выбранный период за вычетом комиссий платёжной системы и сервиса PayToUse.
  • В ожидании: чистая сумма платежей, которые пока не доступны для вывода. Средства становятся доступными для вывода через 7 дней после совершения платежа.
  • Доступно: общая чистая сумма всех платежей, которые уже можно вывести на ваш счёт. Это основной показатель, отражающий ваш фактический баланс, доступный для вывода.

Платежи со статусом Тест исключены из всех четырёх сумм выше, а также из виджета Платежи ниже - они никогда не содержат реальных денег.

Вывести

Под индикатором доступной суммы находится кнопка «Вывести». Она служит для отправки заявки на перевод заработанных средств.

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

Важное примечание: система автоматически использует для вывода всю доступную сумму, указанную в соответствующем поле. Вы не можете указать произвольную сумму, меньшую, чем доступный баланс. Общая сумма вывода равна сумме всех платежей, имеющих статус «доступно для вывода».

В модальном окне вы можете выбрать сумму и валюту для вывода средств. Доступные валюты зависят от ваших способов оплаты.

Примечание: если выбранная валюта не поддерживается для указанного способа вывода средств, запрос на вывод будет отклонен.

Подробнее о статусах и истории ваших запросов на вывод средств - в разделе «Вывод средств».

Платежи

Виджет «Платежи» включает таблицу платежей, сгруппированных по приложениям за выбранный период.

Поля таблицы:

  • Приложение - приложение. В таблице отображаются только те приложения, для которых были совершены платежи за выбранный период.
  • Платежи - количество платежей.
  • Сумма брутто - общая сумма всех платежей пользователей за выбранный период до вычета комиссий платёжных систем и PayToUse.
  • Сумма нетто - общая сумма всех платежей за выбранный период за вычетом комиссий платежных систем и PayToUse.

График показывает динамику значений Сумма нетто и Сумма брутто по дням.

Новые пользователи

График новых пользователей показывает два значения по дням в динамике:

  • Новые пользователи - количество новых вызовов API. Доступ к API записывается только в случае передачи параметра device - уникального идентификатора устройства - при отправке запроса к API. Этот параметр должен быть действительно уникальным для устройства. (см. Отправка запроса)
  • Платежи - количество платежей за тот же период по дням.

Конверсия

Показатель «Конверсия» оценивает, насколько эффективно Новые пользователи превращаются в Платежи.

График показывает соотношение количества Платежи к количеству Новые пользователи в процентах.

Приложения

При переходе в этот раздел открывается список ваших приложений.

Список столбцов в таблице приложений:

  • # - уникальный идентификатор приложения. Используется при проверке кода приложения или отображении формы оплаты.
  • Название - название приложения. Название отображается только вам в отчетах и панели управления. Нажав на название приложения, вы откроете страницу редактирования приложения.
  • Статус - текущий статус приложения. Он соответствует тому, как далеко продвинулся мастер настройки. Может быть:
    • Создано - приложение только что создано, шаг Приложение ещё не завершён.
    • Описание - шаг Описание ещё не завершён.
    • Цена - шаг Цена ещё не завершён.
    • Тест - все шаги настройки завершены, но приложение ещё не запущено. Его можно использовать для тестовых платежей. Оно недоступно конечным пользователям.
    • Запустить - приложение запущено и принимает реальные платежи.
  • Создано - дата создания приложения.
  • Дополнительные кнопки управления:
    • Удалить - удалить приложение из списка.

Создание или редактирование приложения

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

Кнопка создания нового приложения расположена в заголовке списка приложений.

Приложение

Поля, доступные при создании приложения:

  • Название - название приложения, которое видите только вы в отчётах и на панели управления. Название отображается в заголовке страницы сохранённого приложения. Пока приложение не сохранено, вместо названия отображается «Новое приложение». Поле обязательно для заполнения.
  • Контактный email - адрес электронной почты, на который отправляются копии писем пользователям. Этот адрес также указывается в поле «Reply-To», и на него приходит ответ пользователя на письмо с кодом. Поле обязательно для заполнения. По умолчанию заполняется значением из профиля разработчика; его можно изменить.
  • Тип приложения - тип приложения:
    • Одиночный - обычное приложение со своей платёжной формой и своими кодами разблокировки.
    • Группа с ключом только для одного приложения - одна покупка для нескольких приложений. Пользователь платит один раз на платёжной форме группы, и код можно активировать в любом одном приложении группы. После активации в одном приложении код становится недоступен в остальных.
    • Группа с ключом для всех приложений - одна покупка для нескольких приложений. Пользователь платит один раз на платёжной форме группы и получает один код, который работает во всех приложениях группы. В каждом приложении код активируется и привязывается к устройству отдельно. Срок действия кода общий: он отсчитывается от первой активации в любом приложении группы.
  • Список приложений группы - отображается для групповых типов. Выберите приложение в списке и нажмите Добавить. В группу нужно добавить не менее двух приложений. В списке доступны только ваши одиночные приложения, для которых создаются коды разблокировки. Для каждого приложения группы создаётся копия кода группы, а в списке кодов разблокировки такие коды показываются под кодом группы со статусом Неизвестно.
  • Включить обратную связь во время оплаты - добавляет в форму оплаты поле для ввода произвольного текста. Отзыв добавляется в копию письма разработчику. Его также можно увидеть в сведениях о платеже.

Изменения сохраняются автоматически при вводе или изменении значений - кнопки «Сохранить» нет. Сообщение появляется, только если что-то не удалось сохранить. Вы всегда можете вернуться и внести изменения позже.

Переключайтесь между шагами в шапке страницы - она остаётся вверху при прокрутке. Следующий шаг становится доступен, когда текущий заполнен; переход на него сохраняет текущий шаг.

Описание

Выберите язык из списка и нажмите Добавить.

Появится вкладка с локализованными текстами приложения для выбранного языка.

Доступные языки:

  • Немецкий
  • Английский
  • Французский
  • Испанский
  • Русский
  • Китайский (упрощённый)

Поля в описании используются для отображения информации на форме оплаты и в ответном сообщении пользователю:

  • Локализованное название - название приложения на выбранном языке. Отображается на форме оплаты и в письме-уведомлении об оплате. По умолчанию при добавлении языка подставляется название приложения. Для каждого языка можно задать своё название. Обязательное поле.
  • Описание приложения - краткое описание приложения. Отображается на форме оплаты под названием приложения. Необязательное поле: его можно оставить пустым, если описание не нужно.
  • Сообщение о подтверждении покупки - дополнительная информация, которая будет отправлена пользователю в письме после успешной оплаты. Текст ответа добавляется в конце письма после стандартного ответа.

Чтобы сохранить и перейти на следующую страницу, нужно добавить хотя бы один язык.

Язык платёжной формы определяется автоматически по настройкам браузера пользователя. Отметьте один из языков переключателем рядом с его вкладкой (подсказка Использовать по умолчанию): его тексты показываются, если языка пользователя нет среди добавленных.

Чтобы удалить язык, нажмите кнопку удаления на его вкладке и подтвердите удаление.

Изменения сохраняются автоматически при вводе или изменении значений - кнопки «Сохранить» нет. Сообщение появляется, только если что-то не удалось сохранить. Вы всегда можете вернуться и внести изменения позже.

Переключайтесь между шагами в шапке страницы - она остаётся вверху при прокрутке. Следующий шаг становится доступен, когда текущий заполнен; переход на него сохраняет текущий шаг.

Цена

На странице содержится список цен и поля, связанные с оплатой:

  • Пробный период - длительность пробного периода.
  • Единица времени - единица времени пробного периода. Например, если указано 7 дней, то через 7 дней после первого обращения устройства к API приложение получит ответ, что пробный период истёк. Время первого обращения устройства сохраняется.
  • Способ расчёта цены - способ расчёта цены из списка:
    • Расчет цены в зависимости от срока - В форме оплаты пользователь указывает период активации кода, и цена автоматически рассчитывается согласно приведенной ниже таблице. Пользователь получает автоматически сгенерированный код разблокировки в ответном письме.
    • Расчет срока в зависимости от цены - В форме оплаты пользователь выбирает цену из списка или вводит собственное значение цены, и период автоматически рассчитывается согласно таблице ниже. Пользователь получает автоматически сгенерированный код в ответном сообщении.
    • Постоянный код - В форме оплаты пользователь выбирает цену из списка или вводит собственное значение цены. После оплаты он получает код из списка ниже, соответствующий выбранной цене, в ответном электронном письме.
    • Пожертвование - в форме оплаты пользователь выбирает цену из списка или вводит собственную сумму. Для приложений типа «Пожертвование» код разблокировки не генерируется.
    • Временный код с ценой, зависящей от срока и Временный код со сроком, зависящим от цены - приложение получает от API временный код для устройства и показывает его пользователю вместе с QR-кодом, ведущим на платёжную форму. Пользователь оплачивает этот код: цена зависит от выбранного срока, или срок зависит от оплаченной цены, как в способах выше. После оплаты код активируется только для этого устройства. Такой код нельзя сбросить и перенести на другое устройство.

Для групповых приложений доступны только способы Расчет цены в зависимости от срока и Расчет срока в зависимости от цены. Для способа Пожертвование пробный период не используется.

Таблица Список цен задаёт ценовые уровни. Добавьте строку кнопкой Добавить и удалите её кнопкой Удалить. Столбцы таблицы зависят от способа расчёта цены:

  • Срок, Цена - срок действия кода (число и единица времени: дни, месяцы, годы или навсегда) и его цена.
  • Цена, Код - для способа Постоянный код: цена и код, который пользователь получает после её оплаты (до 12 символов).
  • Цена - для способа Пожертвование: только предлагаемые суммы.

Строка, отмеченная переключателем (подсказка Использовать по умолчанию), выбрана на платёжной форме по умолчанию.

Цена устанавливается в долларах США. Минимальная цена - 1 доллар США.

Изменения сохраняются автоматически при вводе или изменении значений - кнопки «Сохранить» нет. Сообщение появляется, только если что-то не удалось сохранить. Вы всегда можете вернуться и внести изменения позже.

Переключайтесь между шагами в шапке страницы - она остаётся вверху при прокрутке. Следующий шаг становится доступен, когда текущий заполнен; переход на него сохраняет текущий шаг.

Предпросмотр

На этой странице задаются значения:

  • Длина кода - длина сгенерированного кода, если применимо.
  • Набор символов кода - набор символов, из которых генерируется код:
    • Числовой код - код генерируется только из цифр 0, 1, 2, 3, 4, 5, 6, 7, 8, 9. Код может содержать ведущие нули. Ведущие нули учитываются при проверке кода.
    • Буквенно-цифровой код - код генерируется с использованием символов 1, 2, 3, 4, 5, 6, 7, 8, 9, A, B, C, D, E, F, G, H, I, G, K, L, M, N, P, Q, R, S, T, U, V, X, Y, Z. Код генерируется и отправляется пользователю в верхнем регистре. Регистр символов не имеет значения при проверке кода.
  • Разрешить ведущие нули в коде - разрешает ведущие нули в сгенерированном коде. Доступно только для набора символов Числовой код.
  • Разрешить повторную отправку кода по идентификатору устройства - позволяет повторно отправить код на тот же email путём повторной проверки идентификатора устройства. Доступно только для одиночных приложений.
  • Конструктор циферблатов - приложение - циферблат из конструктора: на этом шаге вместо ссылки на оплату и примеров кода показывается конструктор. Включено для циферблатов, созданных с главной страницы.
  • Дата выпуска - дата, с которой приложение становится доступно обычным пользователям. Вместе с Бесплатно для бета-тестировщиков после выпуска определяет бесплатный период для устройств, обратившихся к приложению до этой даты.
  • Бесплатно для бета-тестировщиков после выпуска - длительность бесплатного периода (в выбранной Единица времени), предоставляемого устройствам, первый запрос к API которых произошёл до Дата выпуска. Коды, созданные для таких устройств, получают статус Неизвестно.
  • Ссылка для проверки кода - пример ссылки для проверки кода.
  • Ссылка для оплаты - ссылка на оплату. Её можно скопировать и вставить в описание приложения на сайте, где оно опубликовано. Для каждого домена (https://pay-to-use.com для всех языков, https://pay-to-use.ru только для русского) генерируются отдельная ссылка и QR-код, доступные во вкладках над полем ссылки. Параметры для передачи:
    • app - уникальный идентификатор приложения. Обязательный параметр.
    • amount - сумма, которая будет указана в поле цены при покупке. Цена по умолчанию игнорируется. Однако сумма не может быть меньше минимальной цены и не может быть ниже минимальной цены, установленной для приложения. Необязательный параметр.

Ссылка Ссылка для оплаты становится публично доступной только после запуска приложения. До этого используйте кнопку Тестовый платёж ниже, чтобы открыть форму оплаты с подписанным временным токеном доступа - та же форма и те же способы оплаты, что и в реальности, но деньги фактически не списываются: платёж создаётся сразу со статусом Тест, и полностью рабочий код (если применимо) генерируется и отправляется по почте немедленно, без обращения к платёжной системе. Тестовые платежи видны в списке Платежи, помечены статусом Тест, но исключены из итогов Баланс.

Кнопка Тестовый платёж открывает выпадающий список для выбора домена (https://pay-to-use.com или https://pay-to-use.ru), на котором откроется форма тестового платежа - оба варианта одинаково функциональны, выбор имеет значение только если нужно протестировать поведение, специфичное для локали.

Чтобы начать принимать реальные платежи, выключите переключатель Тестовый режим. Перед этим убедитесь, что все введённые данные верны. Ключи, сгенерированные приложением, изменить нельзя. Пока тестовый режим включён, рядом с названием приложения показывается значок Тест. Повторное включение Тестовый режим (после подтверждения) останавливает приём реальных платежей и снова делает доступной кнопку Тестовый платёж.

Проверка кода

Проверка кода разблокировки приложения выполняется в 3 этапа:

  1. Формирование и отправка запроса на проверку кода
  2. Проверки на стороне API
  3. Получение и обработка ответа API
Отправка запроса

Для проверки кода пользователь вашего приложения должен ввести его в поле в настройках приложения.

/resources/settings/properties.xml
<properties>
	<property id="UnlockCode" type="string"></property>
	<property id="UnlockResult" type="string">Checking...</property>
	...
<properties>
/resources/settings/settings.xml
<settings>
	<setting propertyKey="@Properties.UnlockCode" title="@Strings.UnlockCode">
		<settingConfig type="alphaNumeric" maxLength="12"/>
	</setting>
	<setting propertyKey="@Properties.UnlockResult" title="@Strings.UnlockResult">
		<settingConfig type="alphaNumeric" readonly="true"/>
	</setting>
	...
</settings>

Затем необходимо отправить запрос на сервер API Pay-to-use:

/source/background.mc
function onTemporalEvent() as Void {
	var ds = System.getDeviceSettings();
	return Toybox.Communications.makeWebRequest(
		"https://api.pay-to-use.com", // URL API
		{
			"device" => ds.uniqueIdentifier, // уникальный идентификатор устройства
			"app" => "6", // идентификатор вашего приложения
			"model" => ds.partNumber, // артикул устройства
			"code" => Application.Properties.getValue("UnlockCode") // значение кода разблокировки в вашем приложении
		},
		{
			:method => Communications.HTTP_REQUEST_METHOD_POST,
			:headers => { "Content-Type" => Communications.REQUEST_CONTENT_TYPE_JSON },
			:responseType => Communications.HTTP_RESPONSE_CONTENT_TYPE_JSON
		},
		method(:onReceive)
	);
}

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

  • url - https://api.pay-to-use.com. Использование протокола HTTPS является обязательным.
  • Тело запроса (передаваемые значения). Словарь ключей и значений:
    • device - уникальный идентификатор устройства.
    • app - уникальный идентификатор вашего приложения.
    • model — идентификатор модели устройства. Необязательный параметр. Данные используются для отображения статистики по новым устройствам.
    • code - код разблокировки, введенный пользователем в настройках вашего приложения.
  • Параметры запроса:
    • :method - API поддерживает методы запроса GET и POST.
    • :headers - для метода POST параметры должны быть переданы в формате JSON.
    • :responseType - ответ возвращается в формате JSON.
  • responseCallback - ссылка на метод обратного вызова, который должен принимать два аргумента:
    • responseCode - код заголовка ответа сервера.
    • data - содержимое, если запрос выполнен успешно, или null.
Проверки на стороне API

Если параметры не передаются в API, то API возвращает заголовок HTTP/1.1 404 Not Found.

Если хотя бы один параметр передается в API, то API возвращает заголовок HTTP/1.1 200 OK.

Ответ сервера состоит из:

  • response - код ответа
  • msg - текстовое описание ответа
  • expires - временная метка UNIXTIME (если применимо)

Проверяется корректность переданного идентификатора приложения. Приложение должно находиться в статусе Опубликовано в момент оплаты. В случае ошибки возвращается код ответа 301.

Если передан уникальный идентификатор устройства, выполняется его поиск и сохранение. Если при проверке или сохранении возникают ошибки, возвращается код ошибки 402. Если вы получили такой код, немедленно напишите в службу поддержки по адресу [email protected]

Если код передан, следующие шаги выполняются для приложений с методами расчета Расчет цены в зависимости от срока и Расчет срока в зависимости от цены:

  • Если передан пустой код, он отвязывается от уникального идентификатора устройства, определённого на предыдущих шагах.
  • Если передается непустой код и он не активирован, код активируется в зависимости от условий цены, указанной при покупке кода, независимо от даты активации.
  • Если код не был передан или переданный код не найден, возвращается код ошибки 201.
  • Активированный код проверяется на соответствие устройству, и если уникальный идентификатор устройства, отличный от сохраненного, был передан во время активации, возвращается код ошибки 202.
  • Если переданный код не имеет даты истечения срока действия и все предыдущие проверки пройдены, возвращается код 101.
  • Если код имеет ограничение по времени, проводится проверка. Если ключ не истек, возвращается код 101. Если код истек, возвращается код ошибки 203.
  • Для этого типа приложения требуется привязка кода к устройству. Если уникальный идентификатор устройства не был передан, возвращается код ошибки 304.

Для приложения с Постоянный код проверяется только доступность кода на момент покупки. Если код найден, возвращается код 101. Если код не найден, возвращается код ошибки 201.

Для приложения с методом расчета Пожертвование код не проверяется. Всегда возвращается код 101.

Если передан пустой код и у приложения заполнено поле Дата выпуска, проверяется период для бета-тестеров: если устройство впервые обратилось к API до даты выпуска и период Бесплатно для бета-тестировщиков после выпуска ещё не закончился, возвращается код 103.

Если включена опция Разрешить повторную отправку кода по идентификатору устройства и код не передан, ищется действующий код, уже привязанный к устройству. Если он найден, возвращается код 101 вместе с самим кодом.

Если предыдущие проверки не пройдены, проверяется пробный период. Если с первого обращения устройства прошло больше времени, чем задано в текущих настройках приложения, возвращается код ошибки 204. Если пробный период еще не истек, возвращается код ошибки 102.

Если передается только идентификатор приложения, но не передаются ни код разблокировки, ни уникальный идентификатор устройства, возвращается код ошибки 303.

Если возвращен ответ 500, вам следует написать в поддержку по адресу [email protected]

Ниже приведена таблица всех возвращаемых кодов:

Код Сообщение
101 Методы расчета Расчет цены в зависимости от срока и Расчет срока в зависимости от цены:
  • Активен навсегда
{
	"response":101,
	"msg":"Active forever",
	"expires":0
}
  • Активен до [даты]
{
	"response":101,
	"msg":"Active until 7 Mar 2027",
	"expires":1804385267
}
Постоянный код:
{
	"response":101,
	"msg":"The code check was successfull",
	"expires":0
}
Пожертвование:
{
	"response":101,
	"msg":"No code check required",
	"expires":0
}
102
{
	"response":102,
	"msg":"Trial period expires in 18h 36m",
	"expires":1795121047
}
103
{
	"response":103,
	"msg":"Free for beta tester until 13 Jan 2027",
	"expires":1799806067
}
201
{
	"response":201,
	"msg":"Code not found"
}
202
{
	"response":202,
	"msg":"Used on the another device"
}
203
{
	"response":203,
	"msg":"Expiration: 17 Oct 2026",
	"expires":1792202867
}
204
{
	"response":204,
	"msg":"Trial period expired"
}
301
{
	"response":301,
	"msg":"Application not found"
}
302
{
	"response":302,
	"msg":"Term undefined"
}
303
{
	"response":303,
	"msg":"Not enough arguments"
}
304
{
	"response":304,
	"msg":"Device is nesessary"
}
401
{
	"response":401,
	"msg":"Error code saving"
}
402
{
	"response":402,
	"msg":"Error device saving"
}
500
{
	"response":500,
	"msg":"Unknown error"
}
Проверка ответа

Затем вам следует проверить ответ от сервера API Pay-to-use:

/source/background.mc
function onReceive(responseHeader, data) as Void {
	if (responseHeader == 200) { Toybox.Background.exit(data); }
}

Вы можете проверять все заголовки и коды и выводить собственные сообщения для удобства пользователя, но в простейшем виде проверка выглядит примерно так:

/source/app.mc
function onBackgroundData(data) as Void {
	if (data.hasKey("response")) {
		if (data.hasKey("msg")) {
			// Вы можете показать data["msg"] в поле свойств с именем «UnlockResult».
			Application.Properties.setValue("UnlockResult", data["msg"]);
		}
		if (data["response"].toString().substring(0, 1).equals("2")) {
			// Проверка кода не удалась
			// Платные функции НЕ доступны
			...
		} else {
			// Проверка кода прошла успешно, или ошибка на вашей стороне либо на стороне API
			// Платные функции доступны
			...
		}
	}
}

Коды разблокировки

При переходе в этот раздел откроется список кодов разблокировки.

Список кодов разблокировки

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

Последний использованный фильтр сохраняется для пользователя. То есть, при следующем входе на страницу, последний использованный фильтр будет применен автоматически. Фильтры доступны для списка кодов разблокировки:

  • Столбцы - выберите столбцы таблицы для отображения в списке кодов разблокировки.
  • Приложение - отображать только коды разблокировки для выбранных приложений.
  • Статус - отображать только коды разблокировки, которые находятся в выбранных статусах.

Список столбцов в таблице кодов разблокировки:

  • Приложение - ваше приложение. Вы можете перейти по ссылке для редактирования его настроек.
  • Код - код разблокировки.
  • Email - адрес электронной почты, связанный с регистрацией кода разблокировки. Этот адрес используется для поиска клиентских кодов разблокировки в разделе Мои покупки на сайте. Этот раздел доступен пользователям.
  • Срок - период действия отправленного кода (указан в настройках приложения). Период действия установлен для кода в соответствии с условиями настроек приложения на момент его создания.
  • Статус - статус кода разблокировки. (см. Статус кода разблокировки)
  • Создано - дата создания кода разблокировки.
  • Язык - язык пользователя, используется для писем с кодом.
  • Активация - дата активации кода. Устанавливается в момент, когда данное устройство пользователя впервые связывается с сервисом PayToUse API и отправляет этот код. Статус кода меняется на Активирован. Только неактивный код может быть активирован. Если активный код отправляется устройством с другим ID, API возвращает ошибку 202. Только одно устройство может быть связано с одним кодом.
  • Истечение срока - дата истечения срока действия кода. Устанавливается для кодов с ограниченным сроком действия при активации. Для кодов с неограниченным сроком действия дата остается пустой.
  • Удален - дата удаления кода. При удалении статус кода устанавливается на Неизвестно.
  • Устройство - уникальный идентификатор устройства, к которому привязан код.
  • Первое обращение устройства - дата первого обращения устройства к API. От этой даты отсчитываются пробный период и период для бета-тестеров.
  • Последнее обращение устройства - дата последнего обращения устройства к API. Позволяет проверить, используется ли приложение до сих пор.
  • Платеж № - уникальный порядковый номер платежа. Вы можете нажать на ссылку, чтобы посмотреть детали платежа.
  • Примечания - заметки, введённые при ручном создании кодов.
  • Кнопки для действий с кодами разблокировки. Например, удаление.

Статус кода разблокировки

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

Статус Описание
Доступно Статус присваивается коду разблокировки, с которым ещё не выполнено никаких действий или у которого сброшена привязка к устройству.
Активирован Статус устанавливается для кода с установленной датой активации. Дата активации устанавливается, когда устройство успешно обращается к сервису PayToUse API впервые. Также при активации кода устанавливается дата истечения срока действия кода.
Истек Статус устанавливается для истекшего кода. Отвязка кода от устройства не сбрасывает дату истечения срока действия кода. Проверка кода с этим статусом вернет ошибку 203. (см. Проверки на стороне API)
Неизвестно Статус устанавливается при удалении кода. Проверка кода с этим статусом вернет ошибку 201. (см. Проверки на стороне API)
Неизвестно Статус устанавливается для кода, созданного для устройства, первый запрос к API которого произошёл до Дата выпуска приложения - ему предоставляется бесплатный период вместо обычного пробного периода или платной активации, как настроено параметром Бесплатно для бета-тестировщиков после выпуска.
Неизвестно Статус устанавливается для кода, общего для нескольких сгруппированных приложений. Он не привязан к одному приложению и не отображается в списке кодов отдельных приложений группы.
Неизвестно То же, что Неизвестно, но код больше недоступен: он удалён или, для группы с ключом только для одного приложения, уже активирован в одном из приложений группы. При удалении кода группы удаляются и его копии во всех приложениях группы.
Неизвестно Статус устанавливается для кода приложения внутри группы, если он удалён отдельно, в то время как сам код группы остаётся.

Подробности о коде

Нажатие на код в списке открывает страницу сведений о коде. На ней показаны те же поля, что и в списке, и кнопки действий с кодом:

  • Сброс - отвязывает код от устройства и сбрасывает дату активации. Статус кода меняется на Доступно, и код можно активировать на другом устройстве, например, когда пользователь сменил устройство. Дата окончания действия уже активированного кода не сбрасывается. Кнопка недоступна для приложений с временными кодами, так как такой код можно использовать только на одном устройстве.
  • Активировать - доступно для временного кода, который ещё не оплачен. Укажите email пользователя и срок действия кода: код активируется для устройства, к которому он привязан, как если бы он был оплачен. Используйте, например, чтобы передать приложение пользователю бесплатно.
  • Отправить код - отправляет письмо с кодом и сведениями о нём на email кода. Выберите Язык сообщения. Если отмечено Отправить копию разработчику, копия письма отправляется на контактный email приложения. Используйте, если пользователь потерял письмо с кодом.
  • Изменить адрес электронной почты - меняет email кода. Для кода группы email меняется у кода группы и всех его копий. Если код получен в результате оплаты, меняется и email платежа. После этого пользователь найдёт код в разделе Мои покупки по новому email.
  • Удалить - удаляет код. Статус кода меняется на Неизвестно, а проверка кода возвращает ошибку 201. Неоплаченный временный код удаляется полностью.

Действия с кодом также доступны на странице сведений о платеже, если по платежу был отправлен код.

Создать

Кнопка Создать в заголовке списка кодов разблокировки открывает форму создания кодов без оплаты. Например, для бета-тестеров, обозревателей или пользователей, оплативших другим способом. Поля формы:

  • Email - адрес, на который отправляются созданные коды. Копия письма отправляется на контактный email приложения.
  • Приложение - приложение, для которого создаются коды. Доступны только приложения в статусах Тест и Запустить со способом расчёта цены Расчет цены в зависимости от срока или Расчет срока в зависимости от цены.
  • Срок и Единица времени - срок действия кодов. Он отсчитывается с момента активации кода на устройстве.
  • Количество - количество создаваемых кодов.
  • Примечания - произвольный текст, сохраняемый вместе с кодами. Показывается в столбце Примечания списка.
  • Включить заметки в письмо - добавляет заметки в письмо с кодами.

Коды генерируются по настройкам кода приложения (длина и набор символов). После сохранения отображается список созданных кодов и отправляется письмо.

Загрузить

Кнопка Загрузить позволяет загрузить коды, выданные вне PayToUse, например, при переходе с другой системы лицензирования. Выберите приложение, файл и параметры файла:

  • Формат файла - CSV, кодировка UTF-8. Максимальный размер файла указан в форме загрузки.
  • содержит заголовки - отметьте, если первая строка файла содержит названия столбцов. Тогда первая строка пропускается.
  • Разделитель - точка с запятой, запятая или табуляция.

Столбцы файла в следующем порядке:

  1. Код - код разблокировки, обязательно. Переводится в верхний регистр и обрезается до 12 символов. Коды, которые уже есть у приложения, пропускаются.
  2. Email - email пользователя.
  3. Создано - дата создания: дата или метка времени UNIXTIME. Если пусто, используется дата загрузки.
  4. Истечение срока - дата окончания действия: дата или метка времени UNIXTIME. Оставьте пустым, если код ещё не активирован или не имеет срока окончания.
  5. Срок - срок действия после активации: число и единица, например 12h, 30d, 6m или 1y. Если пусто, код действует бессрочно.

После загрузки отображается таблица загруженных строк. Незагруженные строки выделены красным, а сообщение показывает, сколько строк добавлено из общего числа. При загрузке письма пользователям не отправляются.

Скачать

Кнопка Скачать выгружает список кодов разблокировки в файл CSV. В форме выберите поля, которые нужно включить в файл. Файл содержит все коды, соответствующие текущим фильтрам и поиску, а не только коды текущей страницы. Выбранные поля запоминаются для следующей выгрузки.

Платежи

При переходе в этот раздел откроется список платежей пользователей.

Для приема платежей используются следующие платежные системы:

Система Описание
Комиссия платёжной системы составляет от 2,9% + 0,30 USD за каждое успешное списание с карты. Поддерживаются карты, кошельки и другие способы оплаты. Размер комиссии зависит от способа оплаты и может отличаться от комиссии за оплату картой. Подробную информацию о комиссиях платёжной системы можно найти на её сайте.
Комиссия платёжной системы составляет от 3,4% + 0,30 USD за каждый успешный платёж. Поддерживаются карты и PayPal. Подробную информацию о комиссиях платёжной системы можно найти на её сайте.
Комиссия платёжной системы составляет от 3,9% за каждый успешный платёж. Поддерживаются карты и другие способы оплаты. Размер комиссии зависит от способа оплаты. Подробную информацию о комиссиях платёжной системы можно найти на её сайте.

После учета комиссии платежной системы PayToUse взимает комиссию в размере 13%. Мы постоянно работаем над снижением комиссий.

Если в платёжной системе возникают споры или возвраты, штрафы платёжной системы перевыставляются разработчику. Поэтому не допускайте таких ситуаций. В спорных ситуациях комиссия PayToUse не взимается.

Список платежей

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

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

  • Столбцы - выберите столбцы таблицы для отображения в списке платежей.
  • Период - показывать только платежи, созданные в выбранном диапазоне дат.
  • Приложение - отображение платежей только для выбранных приложений.
  • Система - отображение платежей только из выбранных платежных систем.
  • Статус - отображение платежей только с выбранными статусами.

Список столбцов в таблице платежей:

  • Приложение - ваше приложение. Вы можете перейти по ссылке для редактирования его настроек.
  • # - уникальный порядковый номер платежа. Он присваивается платежу автоматически, когда пользователь переходит от формы оплаты на страницу оплаты в платежной системе. Вы можете нажать на ссылку, чтобы просмотреть детали платежа.
  • Комментарии - сообщение от пользователя, введенное в форме оплаты.
  • Система - платежная система, выбранная пользователем.
  • Статус - статус платежа. (см. Статус платежа)
  • Email - электронная почта пользователя, указанная в форме оплаты.
  • Срок - период действия отправленного кода (указанный в настройках приложения).
  • Язык - язык платёжной формы, выбранный пользователем.
  • Создано - дата создания платежа.
  • Сумма счета - сумма платежа, взимаемая с пользователя. Указывается в форме оплаты в зависимости от настроек приложения.
  • Дата платежа - дата платежа.
  • Сумма платежа - сумма платежа, подтвержденная платежной системой.
  • Отправленный код - код, отправленный пользователю.
  • Доступная сумма - доступная сумма для вывода.
  • Сумма выплаты - сумма выведенных средств по платежу.

Детали платежа

Нажатие на # платежа в списке открывает страницу сведений о нём.

Помимо полей, уже перечисленных выше, страница деталей показывает:

  • Код - код, введённый покупателем в форме оплаты, до его проверки и активации. Отображается только для приложений с временными кодами, привязанными к устройству.
  • Сумма платежа (брутто) - сумма, подтверждённая платёжной системой, до вычета комиссий платёжной системы и PayToUse.
  • Сумма платежа (нетто) - сумма, подтверждённая платёжной системой, после вычета комиссий платёжной системы и PayToUse.
  • Идентификаторы платежа - идентификаторы, присвоенные платёжной системой, используемые для поиска платежа в ней при необходимости. Отображаемые поля зависят от платёжной системы:
    • Stripe: Payment Intent, Номер квитанции, Последние 4 цифры.
    • PayPal: Идентификатор платежа, Идентификатор плательщика, Идентификатор транзакции.
    • Robokassa: Идентификатор платежа, ID1, ID2.

Если по платежу был отправлен код, на странице сведений о платеже доступны кнопки Сбросить код, Отправить код и Изменить адрес электронной почты. Они работают так же, как на странице сведений о коде. (см. Подробности о коде)

Статус платежа

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

Статус Описание
Не завершён Статус присваивается платежам, по которым ещё не выполнено никаких действий. Платёж создаётся, как только пользователь переходит с формы оплаты на форму платёжной системы. Платежу присваиваются уникальный порядковый номер и основные атрибуты: сумма, платёжная система, дата.
Успешно Статус присваивается платежам, получившим положительный ответ платёжной системы. Следующий шаг - отправка пользователю письма со сгенерированным кодом или другими данными в зависимости от настроек приложения. Если платёж остаётся в этом статусе, на него нужно обратить особое внимание: последующие действия не выполнены.
Ошибка Статус назначается платежам, для которых получен отрицательный ответ от платежной системы. Последующие шаги не выполняются. Необходимо обратить особое внимание на такие платежи, так как статус на стороне платежной системы может быть обработан с задержкой.
Ожидание Статус назначается платежам, для которых получен положительный ответ от платежной системы, и все последующие шаги были успешно завершены. Вывод средств для платежей с этим статусом недоступен. Платежи автоматически переходят в следующий статус через 7 дней.
Доступно Вывод средств доступен для платежей в этом статусе.
Отправка Статус присваивается платежам, включённым в следующий вывод. Если вывод отменён или отклонён, статус платежа возвращается к Доступно.
Отправлено Статус присваивается платежам, по которым выполнен вывод. Ожидается подтверждение получения средств.
Завершено Статус присваивается платежам с успешным выводом средств. Его можно установить вручную, подтвердив вывод в соответствующем разделе. Также статус меняется автоматически через 14 дней после вывода средств.
Возвращено В этот статус переводятся платежи, по которым выполнен возврат. При возврате взимается комиссия за возврат. Комиссия удерживается из суммы вывода.
Возврат закрыт Возврат, который был включён в уже отправленную выплату. Комиссия за возврат вместо этого списывается с баланса разработчика, поскольку сумму выплаты уменьшить уже нельзя.
Спор Покупатель оспорил платёж (чарджбэк) в платёжной системе. Результат пока не определён.
Спор закрыт Спор разрешён. Как и в случае возврата, любая комиссия за спор, взимаемая платёжной системой, перекладывается на разработчика.
Отменено Платёж был отменён до завершения.
Неизвестно Присваивается при сверке записей платежей с отчётом платёжной системы, текст статуса которого не соответствует ни одному из известных статусов выше. Требует ручной проверки.
Тест Тестовый платёж, сделанный через Тестовый режим приложения, пока оно находится в статусе Тест, до запуска. Сумма и любой сгенерированный код реальны, но деньги фактически не списываются, и платёж исключён из итогов панели управления.

Скачать

Кнопка Скачать в заголовке списка платежей выгружает список в файл Excel (XLSX). Файл содержит столбцы, выбранные в фильтре Столбцы, в том же порядке, и все платежи, соответствующие текущим фильтрам и поиску, а не только платежи текущей страницы.

Вывод средств

При переходе в этот раздел откроется список ваших выводов.

Вывести

Кнопка «Вывести» служит для отправки запроса на перевод заработанных средств.

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

Важное примечание: система автоматически использует для вывода всю доступную сумму, указанную в соответствующем поле. Вы не можете указать произвольную сумму, меньшую, чем доступный баланс. Общая сумма вывода равна сумме всех платежей, имеющих статус «доступно для вывода».

В модальном окне вы можете выбрать сумму и валюту для вывода средств. Доступные валюты зависят от ваших способов оплаты.

Примечание: если выбранная валюта не поддерживается для указанного способа вывода средств, запрос на вывод будет отклонен.

Список выводов средств

Последний использованный фильтр сохраняется для пользователя. Таким образом, при следующем входе на страницу будет автоматически применен последний использованный фильтр. Для списка выводов доступны следующие фильтры:

  • Столбцы - отображение только выбранных столбцов в списке выводов.
  • Статус - отображение только выводов, находящихся в выбранных статусах.

Список столбцов в таблице выводов:

  • # - уникальный порядковый номер вывода. Он присваивается выводу автоматически при сохранении. Вы можете щелкнуть по ссылке, чтобы посмотреть подробности вывода.
  • Статус - статус вывода. (см. Статус вывода)
  • Создано - дата запроса вывода.
  • Сумма - сумма вывода.
  • Вывод средств - дата отправки вывода.
  • Кнопки для действий с выводами. Например, подтверждение.

Вы можете подтвердить вывод, когда он находится в статусе Отправлено.

Детали вывода средств

Нажатие на # вывода в списке открывает страницу сведений о выводе. Помимо полей списка, на ней показаны Подробности - платёжные реквизиты, указанные в запросе на вывод, на которые переводятся средства.

Ниже приведён список платежей, включённых в вывод. Для него доступны фильтры Столбцы, Приложение, Система и Статус, как в списке платежей. (см. Список платежей)

Статус вывода

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

Статус Описание
Ожидание Статус присваивается выводу при создании, пока по нему не выполнено никаких действий.
Отменено Статус присваивается отменённым выводам. Вывод может быть отменён по разным причинам, например, если не указан способ получения средств. Все платежи из этого вывода переходят в статус Доступно и снова доступны для вывода.
Отправлено Статус устанавливается для вывода средств при его отправке.
Завершено Статус устанавливается для ручного вывода, когда разработчик подтверждает получение средств, или автоматически через 14 дней после отправки.
Отклонено Статус устанавливается для вывода, когда банк или платежная система возвращает средства после отправки. Все платежи из этого вывода переходят в статус Доступно и снова доступны для вывода.

Конструктор циферблатов

Конструктор создаёт циферблаты Garmin Connect IQ для вашего приложения без программирования. Вы размещаете элементы на экране каждой модели часов, выбираете, что они показывают и какие из них платные, и скачиваете готовый файл: .prg для установки на свои часы для проверки или .iq для публикации в Connect IQ Store.

Готовый циферблат сам проверяет оплату через PayToUse в соответствии со способом оплаты приложения. Писать код не нужно.

Конструктор открывается кнопкой с ракетой рядом с названием приложения на странице приложения.

Ключ разработчика Connect IQ

Каждый файл .prg и .iq подписывается ключом разработчика — закрытым ключом RSA 4096 бит. Он задаётся один раз в Профиле и используется для всех циферблатов разработчика.

  • Если у вас уже есть приложения в Connect IQ Store, загрузите ключ, которым вы их подписывали: файл developer_key, созданный Connect IQ SDK (например, командой "Monkey C: Generate a Developer Key" в Visual Studio Code). Приложение, опубликованное в магазине, можно обновить только тем же ключом.
  • Если ключа ещё нет, сгенерируйте его кнопкой «Сгенерировать новый ключ». Такой ключ подходит для установки циферблатов на ваши часы и для новых приложений в магазине, но приложения, уже опубликованные с другим ключом, им обновить нельзя.
  • Скачайте ключ и сохраните копию в надёжном месте. Если ключ потерян, приложения, опубликованные с ним, больше нельзя будет обновить в магазине.
  • Принимаются файлы в формате DER или PEM. Ключ не должен быть защищён паролем.

Важно: замена ключа затрагивает все циферблаты разработчика. Предыдущий ключ сохраняется на сервере, но новые сборки подписываются новым.

Модели часов

Список моделей, доступных в конструкторе, задаёт администратор на странице Модели часов: круглые и прямоугольные модели с Connect IQ 4 и новее. В конструкторе модели для циферблата выбираются кнопкой Модели.

У каждой модели своя раскладка: положение, размер и шрифт элементов задаются отдельно, а список элементов, функции и настройки оплаты общие для всех моделей. Новая модель получает раскладку текущей модели, пересчитанную под её экран.

  • Часы / Экран — показать экран на изображении часов или только экран.
  • Реальный размер — показать часы в натуральную величину.
  • Always On — предпросмотр режима Always On на AMOLED-экранах.

Элементы

Циферблат состоит из элементов четырёх типов:

  • Текст — показывает значение функции: время, дату, шаги, пульс, погоду и так далее.
  • Надпись — текст, который вы вводите сами.
  • Стрелки — аналоговые часовая, минутная и секундная стрелки.
  • Изображение — картинка: фон или слой поверх других элементов.

Элементы рисуются в порядке списка на вкладке Элементы: первый — нижний слой. Порядок меняется стрелками в списке и кнопками На задний план и На передний план.

Элементы перемещаются мышью или стрелками на клавиатуре (на 1 px, с Shift — на 10 px). Ctrl+D дублирует элемент, Ctrl+C / Ctrl+V копируют его положение в другую модель, Delete удаляет. Кнопка Скопировать во все модели переносит положение элемента во все выбранные модели. Кнопка Копировать всё во все модели заменяет раскладки всех остальных моделей раскладкой текущей модели: все элементы и фон, масштабированные под каждый экран.

Функции и оплата

У текстового элемента может быть несколько функций. Одна из них показывается по умолчанию; если включено Пользователь может выбрать функцию в настройках, владелец часов выбирает функцию в настройках циферблата в Garmin Connect.

Каждую функцию каждого элемента можно отметить платной: одна и та же функция может быть бесплатной в одном элементе и платной в другом. На вкладке Функции все используемые функции и элементы показаны в одной таблице.

Функциям, отмеченным звёздочкой, нужно дополнительное разрешение (история датчиков, профиль пользователя или местоположение), магазин показывает его при установке циферблата. Разрешение добавляется в циферблат, только если он использует такие функции. Восходу и закату, а также иконкам день/ночь нужно местоположение: последняя GPS-позиция часов (обновляется любой активностью с GPS), иначе место прогноза погоды.

Без оплаты циферблат ведёт себя в зависимости от способа оплаты приложения:

Способ оплаты Без оплаты
Расчет цены в зависимости от срока, Расчет срока в зависимости от цены, Постоянный код Платные функции показывают «paid», платные изображения скрываются. Код разблокировки вводится в настройках циферблата; QR-код страницы покупки находится в меню настроек на часах.
Временный код с ценой, зависящей от срока, Временный код со сроком, зависящим от цены Если циферблат использует платные функции, он показывает экран блокировки с кодом часов и QR-кодом страницы оплаты.
Пожертвование Проверки оплаты нет, отметки платности не учитываются.

На сенсорных экранах касание заблокированного циферблата открывает все функции на 15 минут в качестве пробного доступа.

Иконки

Текстовый элемент может показывать иконку рядом со значением функции. Иконка задаётся для функции один раз на весь циферблат: её меняют в столбце Иконка таблицы функций элемента или на вкладке Функции, и изменение применяется ко всем элементам с этой функцией.

  • Из справочника (по умолчанию) — иконка, которую администратор задал для этой функции в справочнике иконок.
  • Без иконки — функция показывается без иконки.
  • Одна иконка — любая иконка общей библиотеки или ваших собственных иконок.
  • Набор — иконка зависит от значения функции: используется первая строка, у которой значение «до» не меньше значения, последняя строка — для всех больших значений. С «День / ночь» у каждой строки своя ночная иконка, она используется от заката до восхода.

Значения для наборов: батарея — заряд в %, будильники — их количество, связь с телефоном и «не беспокоить» — 1 или 0, луна — возраст в днях, ветер — направление в градусах, погода — код состояния; остальные функции — их число без единиц измерения. Во время зарядки иконки батареи показываются по очереди.

Настройка элемента Показывать выбирает текст и иконку, только текст или только иконку. Положение иконки относительно текста, её размер, цвет, отступ и сдвиг задаются в раскладке каждой модели. Выравнивание элемента применяется ко всему блоку: тексту, отступу и иконке вместе.

Собственные иконки добавляются на вкладке Циферблат в разделе Иконки циферблата: файлы SVG (можно несколько сразу) или шрифт TTF, каждый символ которого становится иконкой. Требования к SVG:

  • иконки одноцветные: цвета файла игнорируются, иконка рисуется цветом, выбранным в конструкторе;
  • используются только залитые фигуры; линии без заливки (stroke) нужно преобразовать в фигуры в векторном редакторе (например, «Контур в путь» в Inkscape или «Outline Stroke» в Figma и Illustrator);
  • отверстия должны быть настоящими вырезами (составной контур или правило заливки evenodd): белая фигура поверх чёрной станет залитой областью;
  • размер иконки — viewBox файла; градиенты, маски, текст и CSS-классы не поддерживаются.

На часах иконки превращаются в растровые изображения нужного размера при сборке циферблата.

Шрифты и изображения

  • Системные шрифты часов доступны для каждой модели. Цифровые шрифты содержат только цифры и несколько знаков.
  • Собственные шрифты TTF или OTF загружаются на вкладке Циферблат и преобразуются в растровые для каждой модели и размера. У модели может быть до 12 разных размеров собственных шрифтов и иконок вместе.
  • Изображения (PNG, JPEG, GIF, WebP до 2000×2000) загружаются на той же вкладке. Изображение либо заполняет экран любой модели, либо имеет свой размер; оно масштабируется для каждой модели, прозрачность сохраняется. До 8 разных изображений или размеров на модель.
  • Изображения занимают графическую память часов; конструктор показывает, сколько её занято на текущей модели.

Режим Always On

На AMOLED-экранах в режиме Always On циферблат показывает только элементы с флажком Показывать в режиме Always On, на чёрном фоне и с небольшим сдвигом каждую минуту для защиты экрана. Garmin допускает в этом режиме не более 10% светящихся пикселей; конструктор показывает это значение над экраном. Секунды и секундная стрелка в этом режиме не показываются.

Сборка

  • Собрать для этих часов (.prg) — файл для текущей модели для установки на ваши часы.
  • Собрать для Connect IQ Store (.iq) — пакет для всех выбранных моделей для публикации в Connect IQ Store. Каждая сборка .iq получает новый номер версии.

Сборки ставятся в очередь и обычно занимают около минуты. На вкладке Сборки видны статус, ссылка на скачивание и журнал сборки.

UUID приложения на вкладке Циферблат определяет приложение в магазине. Не меняйте его между версиями. Чтобы обновить уже опубликованное приложение, укажите его UUID.

Установка файла .prg на часы

Подключите часы к компьютеру USB-кабелем и скопируйте файл .prg в папку GARMIN/Apps на часах. После отключения кабеля циферблат появится в списке циферблатов на часах.

  • Windows: часы появляются в Проводнике как устройство (например, "fēnix 7"). Откройте Internal Storage → GARMIN → Apps и скопируйте туда файл.
  • macOS: большинство современных часов подключаются по MTP, который macOS не поддерживает без дополнительных программ. Установите OpenMTP (бесплатно), подключите часы, откройте GARMIN/Apps и скопируйте туда файл. Перед этим закройте Garmin Express, иначе он перехватит подключение.
  • Linux: часы появляются в файловом менеджере (GNOME Files, Dolphin) как MTP-устройство; откройте GARMIN/Apps и скопируйте туда файл. Без графического окружения часы можно подключить через jmtpfs или simple-mtpfs.

Чтобы удалить циферблат, удалите файл из GARMIN/Apps или удалите его на часах.

Примечание: настройки циферблата, установленного таким способом, нельзя изменить в приложении Garmin Connect, он использует настройки по умолчанию. Чтобы проверить настройки, опубликуйте циферблат в магазине как бета-приложение.

Публикация в Connect IQ Store

Конструктор не загружает файлы в магазин. Войдите в панель разработчика Connect IQ (apps.garmin.com/developer), создайте приложение типа "watch face", загрузите файл .iq, добавьте описание и скриншоты и отправьте приложение на проверку.

Чтобы обновить приложение, соберите новый файл .iq (его версия увеличивается автоматически) и загрузите его как новую версию того же приложения. UUID и ключ разработчика должны остаться прежними.

API

Обзор

API PayToUse выполняет следующие функции:

  1. Проверяет статус активации кода разблокировки и активирует его при необходимости.
  2. Получает данные об уровне глюкозы в крови из приложения NightScout.
  3. Получает текущие данные о погоде для указанного местоположения.

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

Конечные точки API

Можно использовать одну из следующих конечных точек:

  • https://api.pay-to-use.com
  • https://api.p2u.io

Обе конечные точки обрабатывают запросы GET и POST.

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

  • device: строка (обязательный) — уникальный идентификатор устройства
  • app: целое число (обязательный) — ваш ID приложения
  • model: строка (необязательный) — код модели устройства, необходимый для сбора и отображения статистики для устройств, использующих приложение
  • code: строка (необязательный) — код разблокировки
  • bg: ассоциативный массив (необязательный) — данные для запроса уровня глюкозы в крови из приложения NightScout
    • url: строка (необязательный) — адрес приложения NightScout
  • weather: ассоциативный массив (необязательный) — данные для запроса текущей погоды
    • appid: строка (необязательный) — ключ доступа к API погоды
    • lat: число с плавающей запятой (необязательный) — широта
    • lon: число с плавающей запятой (необязательный) — долгота
    • provider: целое число (необязательный) — поставщик погодных данных

Список поддерживаемых поставщиков погодных данных

1. OpenWeatherMap

  • Описание: OpenWeatherMap предоставляет глобальные данные о погоде, включая текущую погоду, исторические данные и 16-дневные прогнозы. С широким географическим охватом и частыми обновлениями, OpenWeatherMap является популярным выбором для приложений, требующих как текущей погоды, так и расширенных прогнозов.
  • Предоставляемые данные: Температура, влажность, скорость ветра, качество воздуха, вероятность осадков и другие данные в реальном времени. Предоставляются как текущие данные, так и прогнозы, включая погодные данные по минутам для выбранных локаций.
  • Выбор поставщика: Включите provider = 1 в раздел weather вашего запроса, чтобы выбрать OpenWeatherMap в качестве поставщика погоды.
  • Примечания по использованию: Предлагает бесплатные и платные уровни с доступом к данным через аутентификацию по ключу API. Расширенные слои данных и премиум-функции доступны в платных планах.
  • One Call API 3.0: UV-индекс доступен только с ключом, подписанным на One Call API 3.0 (отдельная подписка в аккаунте OpenWeatherMap). С таким ключом один запрос One Call заменяет отдельные запросы текущей погоды и прогноза. Если One Call отклоняет ключ, используется бесплатный API 2.5, а One Call пробуется снова через сутки.
  • Документация API: Доступно здесь.

2. QWeather

  • Описание: QWeather (также известный как HeWeather) предоставляет подробные данные о погоде с упором на Китай, но включает и международные данные: текущую погоду, прогнозы, данные о качестве воздуха и предупреждения.
  • Предоставляемые данные: Текущая температура, влажность, УФ-индекс, уровень загрязнения, ежедневные и почасовые прогнозы, а также предупреждения о неблагоприятных погодных условиях. Известен подробными данными о качестве воздуха и обновлениями об изменениях погоды в реальном времени.
  • Выбор поставщика: Включите provider = 2 в раздел weather вашего запроса, чтобы выбрать QWeather в качестве поставщика погоды.
  • Примечания по использованию: QWeather предоставляет доступ к API с бесплатными и платными уровнями. Бесплатный уровень предоставляет ограниченные данные, в то время как платные опции расширяют доступ к дополнительным данным и локациям.
  • Документация API: Доступно здесь.

3. MET Weather (MET Norway)

  • Описание: MET Weather API от MET Norway даёт доступ к разнообразным открытым метеорологическим данным, включая прогнозы, исторические данные и специальные данные по Норвегии и Северной Европе. Благодаря точности и прозрачности MET Weather хорошо подходит для приложений, которым нужны надёжные данные о погоде.
  • Предоставляемые данные: Текущие погодные условия, прогнозы, осадки, температура, данные о ветре и ультрафиолетовом индексе. MET Weather предоставляет специализированные данные для северных регионов, но также поддерживает глобальную информацию о погоде.
  • Выбор поставщика: Включите provider = 3 в раздел weather вашего запроса, чтобы выбрать MET Weather в качестве поставщика погоды.
  • Примечания по использованию: Все данные, предоставляемые MET Weather, доступны для использования бесплатно по лицензии Creative Commons, что позволяет использовать их как в некоммерческих, так и в коммерческих приложениях без затрат. MET Norway известна своими экологическими данными, что делает её надежным поставщиком, особенно в Европе.
  • Документация API: Доступно здесь.

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

/source/background.mc
function onTemporalEvent() as Void {
	var ds = System.getDeviceSettings();
	if (!ds.phoneConnected) { // Проверяет, что устройство подключено к телефону для отправки запроса
		return;
	}

	var id = ds.uniqueIdentifier;
	if (id == null) { // Проверяет, что устройству назначен уникальный идентификатор
		return;
	}

	var request = {};

	var lockCheck = Application.Storage.getValue("LastCodeCheckTimestamp");
	if (lockCheck == null || lockCheck <= Time.now().value()) { // Отправляет код при необходимости
		request.put("code", Application.Properties.getValue("UnlockCode"));
	}

	var ns_url = Application.Properties.getValue("NS");
	if (!ns_url.equals("")) { // Отправляет URL приложения NightScout, если необходимо
		request.put("bg", { "url" => ns_url });
	}

	var wP = Application.Properties.getValue("Weather");
	if (wP != 0) { // Отправляет параметры запроса погоды, если необходимо
		var lat = Application.Properties.getValue("latitude");
		var lon = Application.Properties.getValue("longitude");
		if (!lat.equals("") && !lon.equals("")) {
			request.put("weather", {
				"appid" => Application.Properties.getValue("appID"),
				"lat" => lat,
				"lon" => lon,
				"provider" => wP
			});
		}
	}

	if (!request.isEmpty()) {

		// Заполняет необходимые параметры запроса
		request.put("device", id);
		request.put("app", p2uAppID); // идентификатор вашего приложения
		request.put("model", ds.partNumber);

		Toybox.Communications.makeWebRequest(
			"https://api.p2u.io", // Конечная точка API
			request,
			{
				:method => 3, // Communications.HTTP_REQUEST_METHOD_POST
				:headers => {
					"Content-Type" => 1 // Communications.REQUEST_CONTENT_TYPE_JSON
				},
				:responseType => 0 // Communications.HTTP_RESPONSE_CONTENT_TYPE_JSON
			},
			method(:onReceive)
		);
	}
}

Ответ API

API возвращает объект JSON с информацией о статусе разблокировки, уровне глюкозы и погоде.

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

Результаты проверки кода разблокировки (если запрос был отправлен):

  • response: целое число — код возврата
  • msg: строка — сообщение о результате проверки
  • code: строка — код разблокировки, к которому относится результат, если он известен
  • expires: целое число — временная метка истечения срока действия кода в формате UNIXTIMESTAMP
  • qr: array — QR-код для покупки или проверки серийного номера, если применимо

Ответ приложения NightScout (если запрос был отправлен):

  • bg: ассоциативный массив — отформатированный ответ от приложения NightScout
    • value: целое число — уровень глюкозы в крови в мг/дл
    • date: целое число — временная метка истечения срока действия кода в формате UNIXTIMESTAMP
    • direction: строка — тренд изменения уровня глюкозы в крови

Ответ Weather API (если запрос был отправлен):

  • weather: ассоциативный массив — отформатированный ответ от Weather API
    • provider: целое число — идентификатор поставщика погодных данных
    • weather: array — текущие погодные условия. Может возвращать одно или два значения; если два значения, они представляют дневные и ночные условия
    • temp: число с плавающей запятой — текущая температура в градусах Цельсия
    • feels_like: число с плавающей запятой — ощущаемая температура в градусах Цельсия
    • pressure: целое число — атмосферное давление в гПа
    • humidity: целое число — влажность в %
    • precipitation: целое число — вероятность осадков в %
      Для MET Weather — только в Северной Европе. -1, если значение недоступно.
    • wind: целое число — направление ветра в градусах
    • wind_speed: число с плавающей запятой — скорость ветра в м/с
    • wind_gust: число с плавающей запятой — скорость порывов ветра в м/с
      Недоступно для QWeather. Для MET Weather — только в Северной Европе. -1, если значение недоступно.
    • uvi: число с плавающей запятой — UV-индекс
      Для OpenWeatherMap — только с ключом, подписанным на One Call API 3.0. Для QWeather — дневной максимум. Для MET Weather — UV-индекс при ясном небе. -1, если значение недоступно.
    • temp_low: число с плавающей запятой — минимальная температура сегодня в градусах Цельсия
    • temp_high: число с плавающей запятой — максимальная температура сегодня в градусах Цельсия
    • sunrise_today: целое число — временная метка восхода солнца сегодня в формате UNIXTIMESTAMP
    • sunset_today: целое число — временная метка захода солнца сегодня в формате UNIXTIMESTAMP
    • sunrise_tomorrow: целое число — временная метка восхода солнца завтра в формате UNIXTIMESTAMP
    • sunset_tomorrow: целое число — временная метка захода солнца завтра в формате UNIXTIMESTAMP
    • aqi: ассоциативный массив — индекс качества воздуха
      • level: целое число — уровень индекса качества воздуха
      • value: целое число — значение индекса качества воздуха

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

https://api.p2u.io
{
	"response": 103,
	"msg": "Free for beta tester",
	"expires": 0,
	"qr": [
		"11111110111011010110101111111",
		"10000010111001001101001000001",
		"10111010101100110110101011101",
		"10111010110101000001001011101",
		"10111010000001010100001011101",
		"10000010100110001101001000001",
		"11111110101010101010101111111",
		"00000000010010110111100000000",
		"11001110000100100100100101111",
		"11111100011011011010011111111",
		"01111011100111111100101000001",
		"01111100101100110111011011011",
		"00110110101010100101110000010",
		"11001000010001011000001011111",
		"01101010001001110100000001101",
		"10111101100010100101100110011",
		"01010111111100110100100100010",
		"10000100111011011000101111011",
		"00000110110110110100100000101",
		"00111100011100001100101100011",
		"11110111110010100111111111001",
		"00000000111001011101100010001",
		"11111110010001011111101011101",
		"10000010100010100111100010010",
		"10111010101101100111111111001",
		"10111010010010110000010000001",
		"10111010001111111110000001111",
		"10000010111101011111101101011",
		"11111110100011011110110010010"
	],
	"bg": {
		"value": -102,
		"date": 1730546101,
		"direction": ""
	},
	"weather": {
		"provider": 1,
		"weather": [
			89
		],
		"temp": 0.27,
		"feels_like": -3.14,
		"pressure": 999,
		"humidity": 78,
		"precipitation": 0,
		"wind": 120,
		"wind_speed": 2.96,
		"wind_gust": 5.21,
		"uvi": 0.4,
		"temp_low": -3.8,
		"temp_high": 0.27,
		"sunrise_today": 1730527969,
		"sunset_today": 1730551770,
		"sunrise_tomorrow": 1730614492,
		"sunset_tomorrow": 1730638051,
		"aqi": {
			"level": 1,
			"value": 38
		}
	}
}

Коды ответа

Поле response результата проверки кода разблокировки принимает одно из следующих значений. Примеры ответов и порядок проверок описаны в разделе Проверки на стороне API.

Код Описание
101Код действителен. Приложение можно разблокировать.
102Действующего кода нет, но пробный период ещё не закончился. Приложение можно разблокировать до даты из поля expires.
103Действующего кода нет, но устройство является бета-тестером: его первое обращение к API было раньше даты из поля Дата выпуска приложения. Приложение можно разблокировать до даты из поля expires (0 - без ограничения).
201Код не найден или удалён.
202Код уже активирован на другом устройстве.
203Срок действия кода истёк.
204Пробный период закончился, а действующий код не передан.
301Приложение не найдено или недоступно.
302Срок действия кода не определён.
303В запросе недостаточно параметров.
304Для этого приложения обязателен идентификатор устройства.
401Ошибка сохранения кода. Напишите в поддержку на [email protected].
402Ошибка сохранения устройства. Напишите в поддержку на [email protected].
500Неизвестная ошибка. Напишите в поддержку на [email protected].

Коды 1xx означают, что приложение можно разблокировать, 2xx - что оно должно оставаться заблокированным, 3xx - ошибку в запросе, 4xx и 5xx - ошибку на стороне PayToUse. При ошибках 4xx и 5xx рекомендуется сохранить последний успешный результат и повторить запрос позже.

Если в настройках приложения включена опция Разрешить повторную отправку кода по идентификатору устройства, в запросе передан идентификатор устройства, но не передан код, а к этому устройству уже привязан действующий код, API возвращает 101 вместе с этим кодом в поле code. Приложение может сохранить его и больше не просить пользователя вводить код.

Примечания

  • Запросы с bg требуют подключения к приложению NightScout.
  • Для каждого запроса с code API автоматически проверяет статус кода и активирует его, если он неактивен.
  • Обратите внимание, что параметры API могут обновляться или изменяться со временем для улучшения функциональности, совместимости и безопасности. Рекомендуется периодически проверять документацию API на предмет изменений, которые могут повлиять на интеграцию или использование.

Погодные провайдеры

Ниже приведено соответствие погодных условий, возвращаемых в поле weather, и значений каждого провайдера.

Garmin

Для подробного описания функций и констант погоды Garmin SDK, обратитесь к этой ссылке. Вы можете сохранять значения, полученные через API, или результаты функций Garmin SDK, в зависимости от выбранного поставщика погоды, для обеспечения согласованности отображаемых значений на экране.

ID Описание День Ночь
0 Ясное небо
0x53

0x54
40 Хорошая погода
23 Преимущественно ясно
0x55

0x56
1 Переменная облачность
0x57

0x58
22 Небольшая облачность
2 Преимущественно облачно
0x59
52 Тонкая облачность
20 Облачно
0x5A
45 Облачно, возможен дождь
31 Морось
0x3E
14 Небольшой дождь
0x42
24 Небольшие ливни
3 Дождь
0x43
25 Ливни
27 Возможны ливни
0x46
11 Местами ливни
15 Сильный дождь
26 Сильные ливни
28 Возможна гроза
0x36

0x37
12 Местами грозы
0x38
6 Гроза
0x39
8 Туман
0x4E
9 Дымка
29 Лёгкий туман
39 Мгла
30 Пыль
0x4F
35 Песок
33 Дым
38 Вулканический пепел
37 Песчаная буря
13 Осадки
5 Ветрено
0x52
36 Шквал
48 Кратковременный снег
32 Торнадо
0x50
41 Ураган
42 Тропический шторм
50 Ледяная крупа
0x45
7 Смешанные осадки
18 Небольшой дождь со снегом
19 Сильный дождь со снегом
21 Дождь со снегом
49 Ледяной дождь
44 Возможен дождь со снегом
47 Облачно, возможен дождь со снегом
34 Лёд
51 Снежная крупа
43 Возможен снег
0x4C

0x4D
16 Небольшой снег
46 Облачно, возможен снег
0x4A
4 Снег
17 Сильный снег
0x4B
10 Град
0x3A

Open Weather Map

Пример набора иконок для OpenWeatherMap можно посмотреть здесь.

ID Описание День Ночь
2xx Гроза
200 Гроза с небольшим дождём
0x36

0x37
201 Гроза с дождём
0x38
202 Гроза с сильным дождём
210 Слабая гроза
211 Гроза
0x39
212 Сильная гроза
0x3B
221 Местами гроза
230 Гроза с небольшой моросью
0x3A
231 Гроза с моросью
232 Гроза с сильной моросью
3xx Морось
300 Слабая морось
0x3C

0x3D
301 Морось
0x3E
302 Сильная морось
0x3F
310 Слабая морось с дождём
0x40
311 Морось с дождём
312 Сильная морось с дождём
0x41
313 Ливень и морось
314 Сильный ливень и морось
321 Ливневая морось
5xx Дождь
500 Небольшой дождь
0x42
501 Умеренный дождь
0x43
502 Сильный дождь
0x44
503 Очень сильный дождь
504 Очень сильный ливень
511 Ледяной дождь
0x45
520 Небольшой ливень
0x46
521 Ливень
522 Сильный ливень
531 Местами ливень
6xx Снег
600 Небольшой снег
0x4C

0x4D
601 Снег
0x4A
602 Сильный снег
611 Ледяная крупа
0x45
612 Небольшой ливневый мокрый снег
613 Ливневый мокрый снег
615 Небольшой дождь со снегом
616 Дождь со снегом
620 Небольшой снегопад
0x4B
621 Снегопад
622 Сильный снегопад
7xx Атмосферные явления
701 Лёгкий туман
0x4E
711 Дым
0x4F
721 Мгла
731 Песчаные/пыльные вихри
741 Туман
751 Песок
0x4F
761 Пыль
762 Вулканический пепел
771 Шквалы
0x52
781 Торнадо
0x50
800 Ясное небо
800 Ясное небо
0x53

0x54
80x Облачность
801 Малооблачно 11–25%
0x55

0x56
802 Переменная облачность 25–50%
0x57

0x58
803 Облачно с прояснениями 51–84%
0x59
804 Пасмурно 85–100%
0x5A

QWeather

Оригинальный набор иконок погоды можно посмотреть здесь

ID Описание День Ночь
302 Гроза с ливнем
0x36

0x37
303 Сильная гроза
0x38
310 Ливневый дождь
0x39
317 Ливень, местами сильный
304 Град
0x3A
311 Сильный ливень
0x3B
312 Очень сильный ливень
318 Сильный, местами очень сильный ливень
309 Моросящий дождь
0x3C

0x3D
404 Ледяная крупа
0x3E
305 Легкий дождь
0x42
314 Небольшой, местами умеренный дождь
306 Умеренный дождь
0x43
315 Умеренный, местами сильный дождь
399 Дождь
308 Очень сильный дождь
0x44
316 Сильный дождь, местами ливень
313 Ледяной дождь
0x45
405 Дождь со снегом
300 Ливень
0x46
301 Сильный ливень
307 Сильный дождь
350 Ливень
351 Сильный ливень
400 Небольшой снег
0x4C

0x4D
408 Небольшой, местами умеренный снег
499 Снег
401 Умеренный снег
0x4A
402 Сильный снег
409 Умеренный, местами сильный снег
410 Сильный снег, местами метель
403 Метель
0x4B
406 Ливневый дождь со снегом
407 Кратковременный снег
456 Ливневый дождь со снегом
457 Кратковременный снег
503 Песок
0x4E
504 Пыль
507 Пыльная буря
508 Песчаная буря
511 Умеренная мгла
512 Сильная мгла
513 Очень сильная мгла
500 Лёгкий туман
0x4F
501 Туман
502 Мгла
509 Густой туман
510 Сильный туман
514 Очень густой туман
515 Чрезвычайно густой туман
100 Солнечно
0x53

0x54
150 Ясное небо
101 Облачно
0x55

0x56
151 Облачно
102 Малооблачно
0x57

0x58
152 Малооблачно
103 Переменная облачность
0x59
153 Переменная облачность
104 Пасмурно
0x5A

MET Weather

Пример набора иконок для MET Weather можно посмотреть здесь.

ID Описание День Ночь
lightrainshowers Небольшой ливень
0x36

0x37
lightrainshowersandthunder Небольшой ливень с грозой
rainshowersandthunder Ливень с грозой
heavyrainshowersandthunder Сильный ливень с грозой
heavyrainandthunder Сильный дождь с грозой
0x38
rainandthunder Дождь с грозой
lightrainandthunder Небольшой дождь с грозой
0x39
heavysleetandthunder Сильный мокрый снег с грозой
0x3B
lightsleetandthunder Небольшой мокрый снег с грозой
0x3A
lightssleetshowersandthunder Небольшой ливневый мокрый снег с грозой
sleetandthunder Мокрый снег с грозой
lightsleetshowers Небольшой ливневый мокрый снег
0x3C

0x3D
sleetshowers Ливневый мокрый снег
sleetshowersandthunder Ливневый мокрый снег с грозой
heavysleetshowers Сильный ливневый мокрый снег
heavysleetshowersandthunder Сильный ливневый мокрый снег с грозой
lightsleet Небольшой мокрый снег
0x3E
sleet Ледяная крупа
0x3F
heavysleet Сильный мокрый снег
0x45
lightrain Небольшой дождь
0x42
rain Дождь
0x43
heavyrain Сильный дождь
0x44
rainshowers Ливень
0x46
heavyrainshowers Сильный ливень
heavysnow Сильный снег
0x4B
heavysnowandthunder Сильный снег с грозой
snow Снег
snowandthunder Снег с грозой
lightsnowshowers Небольшой снегопад
0x4C

0x4D
lightssnowshowersandthunder Небольшой снегопад с грозой
snowshowers Снегопад
snowshowersandthunder Снегопад с грозой
heavysnowshowers Сильный снегопад
heavysnowshowersandthunder Сильный снегопад с грозой
lightsnow Небольшой снег
0x4A
lightsnowandthunder Небольшой снег с грозой
fog Туман
0x4F
clearsky Ясное небо
0x53

0x54
fair Хорошая погода
0x55

0x56
partlycloudy Переменная облачность
0x57

0x58
cloudy Облачно
0x59