Podręcznik
Wstęp
Pasek boczny po lewej zawiera odnośniki do odpowiednich sekcji:
- Nazwa użytkownika - odnośniki do profilu osobistego.
- Panel - wyświetl bieżący stan w formie wykresów i grafów.
- Aplikacje - zarządzanie aplikacją.
- Kody odblokowujące - kody odblokowujące generowane automatycznie lub wczytane przez Ciebie.
- Płatności - historia przychodzących płatności użytkowników.
- Podręcznik - ten podręcznik użytkownika.
Panel
Możesz ustawić wspólne filtry dla wszystkich widżetów w panelu:
- Waluta - waluta, na którą zostaną przeliczone przychodzące i wychodzące kwoty w panelu.
- Okres - to okres czasu, dla którego dane są wyświetlane na wykresach i tabelach w panelu. Określa interwał, w którym analizowane i wyświetlane są informacje i statystyki dotyczące płatności, aplikacji i innych parametrów.
Saldo
W tej sekcji panelu wyświetlane są kluczowe wskaźniki finansowe dotyczące wypłat. Zawiera ona zbiorcze informacje o wszystkich płatnościach użytkowników, z uwzględnieniem opłat pobieranych przez systemy płatnicze oraz serwis PayToUse.
W tym bloku wyświetlane są następujące kwoty:
- Brutto: Łączna kwota wszystkich płatności użytkowników za wybrany okres, przed potrąceniem jakichkolwiek opłat.
- Netto: Łączna kwota wszystkich płatności za wybrany okres po odliczeniu opłat systemu płatności oraz opłat za usługę PayToUse.
- Oczekujące: Kwota netto z płatności, które nie są jeszcze dostępne do wypłaty. Środki stają się dostępne do wypłaty 7 dni po dokonaniu płatności.
- Dostępne: Łączna kwota netto wszystkich płatności, które można już wypłacić na Twoje konto. Jest to główny wskaźnik odzwierciedlający rzeczywiste saldo dostępne do wypłaty.
Płatności ze statusem Test są wykluczone ze wszystkich czterech powyższych kwot, a także z widżetu Płatności poniżej - nigdy nie dotyczą prawdziwych pieniędzy.
Wypłać
Pod wskaźnikiem dostępnej kwoty znajduje się przycisk „Wypłać”. Służy on do złożenia wniosku o przelanie zgromadzonych środków.
Po kliknięciu tego przycisku otworzy się okno modalne, w którym należy podać szczegóły płatności dotyczące przelewu.
Ważna uwaga: System automatycznie wykorzystuje do wypłaty całą dostępną kwotę wskazaną w odpowiednim polu. Nie można podać dowolnej kwoty niższej niż dostępne saldo. Łączna kwota wypłaty stanowi sumę wszystkich płatności o statusie „dostępne do wypłaty”.
W oknie modalnym możesz wybrać kwotę i walutę wypłaty. Dostępne waluty zależą od posiadanych metod płatności.
Uwaga: Jeśli wybrana waluta nie jest obsługiwana przez wybraną metodę wypłaty, zlecenie wypłaty zostanie odrzucone.
Więcej informacji na temat statusów i historii Twoich wniosków o wypłatę znajdziesz w sekcji Wypłaty.
Płatności
Widżet Płatności zawiera tabelę płatności pogrupowanych według aplikacji dla wybranego okresu.
Pola tabeli:
- Aplikacja - aplikacja. W tabeli wyświetlane są tylko aplikacje, dla których dokonano płatności w wybranym okresie.
- Płatności - liczba płatności.
- Kwota brutto - łączna kwota wszystkich płatności użytkowników za wybrany okres przed potrąceniem opłat systemów płatności i PayToUse.
- Kwota netto - łączna kwota wszystkich płatności za wybrany okres, pomniejszona o opłaty systemów płatności i PayToUse.
Wykres pokazuje dynamikę wartości Kwota netto i Kwota brutto dziennie.
Nowi użytkownicy
Wykres nowych użytkowników pokazuje dwie wartości w dynamice dziennie:
- Nowi użytkownicy - liczba nowych wywołań interfejsu API. Dostępy do API są rejestrowane tylko wtedy, gdy parametr device - unikalny identyfikator urządzenia - jest przekazywany podczas wysyłania żądania do interfejsu API. Ten parametr musi być rzeczywiście unikalny dla urządzenia. (zobacz Wysyłanie żądania)
- Płatności - liczba płatności w tym samym okresie dziennie.
Konwersja
Wskaźnik konwersji pokazuje, jak skutecznie przekształcasz Nowi użytkownicy w Płatności.
Wykres pokazuje stosunek liczby Płatności do liczby Nowi użytkownicy, w procentach.
Aplikacje
Po przejściu do tej sekcji otwiera się lista twoich aplikacji.
Lista kolumn w tabeli aplikacji:
- # - unikalny identyfikator aplikacji. Używany podczas weryfikacji kodu aplikacji lub wyświetlania formularza płatności.
- Nazwa - nazwa aplikacji. Nazwa jest wyświetlana tylko tobie w raportach i na panelu. Kliknięcie na nazwę aplikacji otwiera stronę edycji aplikacji.
- Status - bieżący status aplikacji. Odpowiada temu, jak daleko posunął się kreator konfiguracji. Może to być:
- Utworzony - aplikacja została właśnie utworzona, krok Aplikacja nie jest jeszcze ukończony.
- Opis - krok Opis nie jest jeszcze ukończony.
- Cena - krok Cena nie jest jeszcze ukończony.
- Test - wszystkie kroki konfiguracji zostały ukończone, ale aplikacja nie została jeszcze uruchomiona. Można jej użyć do płatności testowych. Nie jest dostępna dla użytkowników końcowych.
- Uruchom - aplikacja jest uruchomiona i akceptuje prawdziwe płatności.
- Utworzony - data utworzenia aplikacji.
- Dodatkowe przyciski sterujące:
- Usuń - aby usunąć aplikację z listy.
Tworzenie lub edycja aplikacji
Aby akceptować płatności, musisz kolejno wypełnić wszystkie niezbędne dane aplikacji i ją aktywować.
Przycisk tworzenia nowej aplikacji znajduje się na pasku tytułowym listy aplikacji.
Aplikacja
Pola dostępne podczas tworzenia aplikacji:
- Nazwa - nazwa aplikacji, którą widzisz tylko ty w raportach lub w panelu. Ta nazwa zostanie wyświetlona w nagłówku strony zapisanej aplikacji. Dopóki aplikacja nie zostanie zapisana, zamiast nazwy wyświetlane jest „Nowa aplikacja”. Pole jest obowiązkowe do wprowadzenia.
- Adres email kontaktowy - adres e-mail, na który będą wysyłane kopie wiadomości wysłanych do użytkowników. Ten adres jest również określony w polu „Odpowiedz do” i służy do odpowiedzi użytkownika na otrzymany e-mail z kodem. Pole jest obowiązkowe do wprowadzenia. Domyślnie pole jest wypełniane wartością z profilem dewelopera. Wartość można zmienić na inną.
- Typ aplikacji - typ aplikacji:
- Pojedynczy - zwykła aplikacja z własnym formularzem płatności i własnymi kodami odblokowującymi.
- Grupa z kluczem dla jednej aplikacji - jeden zakup dla kilku aplikacji. Użytkownik płaci raz w formularzu płatności grupy, a kod można aktywować w dowolnej jednej aplikacji z grupy. Po aktywacji w jednej aplikacji kod staje się niedostępny w pozostałych.
- Grupa z kluczem dla wszystkich aplikacji - jeden zakup dla kilku aplikacji. Użytkownik płaci raz w formularzu płatności grupy i otrzymuje jeden kod, który działa we wszystkich aplikacjach grupy. W każdej aplikacji kod jest aktywowany i przypisywany do urządzenia osobno. Okres ważności kodu jest wspólny: liczy się od pierwszej aktywacji w dowolnej aplikacji grupy.
- Lista aplikacji grupy - wyświetlana dla typów grupowych. Wybierz aplikację z listy i kliknij Dodaj. Do grupy należy dodać co najmniej dwie aplikacje. Na liście dostępne są tylko Twoje pojedyncze aplikacje, dla których generowane są kody odblokowujące. Dla każdej aplikacji grupy tworzona jest kopia kodu grupy, a na liście kodów odblokowujących takie kody są wyświetlane pod kodem grupy ze statusem Nieznany.
- Włącz opinie podczas płatności - dodaje pole do formularza płatności, w którym użytkownicy mogą wprowadzić tekst. Opinia zostanie dodana do kopii e-maila dewelopera. Opinię można też zobaczyć w szczegółach płatności.
Zmiany są zapisywane automatycznie podczas wpisywania lub zmiany wartości - nie ma przycisku Zapisz. Komunikat pojawia się tylko wtedy, gdy czegoś nie udało się zapisać. Zawsze możesz wrócić i wprowadzić zmiany później.
Przełączaj kroki w nagłówku strony - pozostaje on na górze podczas przewijania. Następny krok staje się dostępny, gdy bieżący jest wypełniony; przejście do niego zapisuje bieżący krok.
Opis
Wybierz język z listy i kliknij Dodaj.
Zostanie wyświetlona karta ze zlokalizowanymi tekstami aplikacji dla wybranego języka.
Dostępne języki:
- Niemiecki
- Angielski
- Francuski
- Hiszpański
- Rosyjski
- Chiński uproszczony
Pola opisu są używane do wyświetlania informacji w formularzu płatności i w wiadomości z odpowiedzią do użytkownika:
- Nazwa zlokalizowana - nazwa aplikacji w wybranym języku. Wyświetla się na formularzu płatności i w e-mailu powiadomieniowym o płatności. Domyślnie, po dodaniu języka, wstawiana jest nazwa aplikacji. Możesz ustawić inną nazwę dla każdego języka. Pole wymagane.
- Opis aplikacji - krótki opis aplikacji. Wyświetlany na formularzu płatności pod nazwą aplikacji. Pole opcjonalne. Możesz je pozostawić puste, jeśli nie chcesz wyświetlać żadnego opisu.
- Wiadomość potwierdzenia zakupu - dodatkowe informacje, które zostaną wysłane do użytkownika w e-mailu po pomyślnej płatności. Tekst odpowiedzi jest dodawany na końcu e-maila po standardowej odpowiedzi.
Aby zapisać i przejść do następnej strony, należy dodać przynajmniej jeden język.
Język formularza płatności jest określany automatycznie na podstawie ustawień przeglądarki użytkownika. Zaznacz jeden z języków przyciskiem opcji obok jego karty (podpowiedź Użyj domyślnego): jego teksty są wyświetlane, gdy języka użytkownika nie ma wśród dodanych.
Aby usunąć język, kliknij przycisk usuwania na jego karcie i potwierdź usunięcie.
Zmiany są zapisywane automatycznie podczas wpisywania lub zmiany wartości - nie ma przycisku Zapisz. Komunikat pojawia się tylko wtedy, gdy czegoś nie udało się zapisać. Zawsze możesz wrócić i wprowadzić zmiany później.
Przełączaj kroki w nagłówku strony - pozostaje on na górze podczas przewijania. Następny krok staje się dostępny, gdy bieżący jest wypełniony; przejście do niego zapisuje bieżący krok.
Cena
Strona zawiera listę cen i pól związanych z płatnościami:
- Okres próbny - długość okresu próbnego.
- Jednostka czasu - jednostka czasu okresu próbnego. Na przykład, jeśli określisz 7 dni, oznacza to, że po 7 dniach od pierwszego wywołania interfejsu API aplikacji, zostanie zwrócona odpowiedź, że okres próbny minął. Czas pierwszego wywołania urządzenia jest zapisywany.
- Metoda obliczania ceny - Metoda obliczania ceny z listy:
- Obliczanie ceny w zależności od okresu - W formularzu płatności użytkownik określa okres aktywacji kodu, a cena jest automatycznie obliczana zgodnie z tabelą poniżej. Użytkownik otrzymuje automatycznie wygenerowany kod odblokowujący w wiadomości e-mail z odpowiedzią.
- Obliczanie okresu w zależności od ceny - W formularzu płatności użytkownik wybiera cenę z listy lub wprowadza swoją własną wartość ceny, a okres jest automatycznie obliczany zgodnie z tabelą poniżej. Użytkownik otrzymuje automatycznie wygenerowany kod w wiadomości odpowiedzi.
- Stały kod - W formularzu płatności użytkownik wybiera cenę z listy lub wprowadza własną wartość ceny. Po dokonaniu płatności otrzymuje w wiadomości e-mail z odpowiedzią kod z listy poniżej, odpowiadający wybranej cenie.
- Darowizna - W formularzu płatności użytkownik wybiera cenę z listy lub wprowadza własną wartość ceny. Dla aplikacji typu „Darowizna” kod odblokowujący nie jest generowany.
- Kod tymczasowy z ceną zależną od okresu i Kod tymczasowy z okresem zależnym od ceny - aplikacja otrzymuje z API tymczasowy kod dla urządzenia i pokazuje go użytkownikowi razem z kodem QR prowadzącym do formularza płatności. Użytkownik płaci za ten kod: cena zależy od wybranego okresu lub okres zależy od zapłaconej ceny, jak w metodach powyżej. Po płatności kod jest aktywowany tylko dla tego urządzenia. Takiego kodu nie można zresetować ani przenieść na inne urządzenie.
Dla aplikacji grupowych dostępne są tylko metody Obliczanie ceny w zależności od okresu i Obliczanie okresu w zależności od ceny. W metodzie Darowizna okres próbny nie jest używany.
Tabela Lista cen określa poziomy cen. Dodaj wiersz przyciskiem Dodaj i usuń go przyciskiem Usuń. Kolumny tabeli zależą od metody obliczania ceny:
- Okres, Cena - okres ważności kodu (liczba i jednostka czasu: dni, miesiące, lata lub na zawsze) oraz jego cena.
- Cena, Kod - dla metody Stały kod: cena i kod, który użytkownik otrzymuje po jej zapłaceniu (do 12 znaków).
- Cena - dla metody Darowizna: tylko proponowane kwoty.
Wiersz zaznaczony przyciskiem opcji (podpowiedź Użyj domyślnego) jest domyślnie wybrany w formularzu płatności.
Cena jest podana w dolarach amerykańskich. Minimalna cena to 1 dolar amerykański.
Zmiany są zapisywane automatycznie podczas wpisywania lub zmiany wartości - nie ma przycisku Zapisz. Komunikat pojawia się tylko wtedy, gdy czegoś nie udało się zapisać. Zawsze możesz wrócić i wprowadzić zmiany później.
Przełączaj kroki w nagłówku strony - pozostaje on na górze podczas przewijania. Następny krok staje się dostępny, gdy bieżący jest wypełniony; przejście do niego zapisuje bieżący krok.
Podgląd
Na tej stronie ustawia się wartości:
- Długość kodu - długość wygenerowanego kodu, jeśli dotyczy.
- Zestaw znaków kodu - zestaw znaków, z którego generowany jest kod:
- Kod numeryczny - kod jest generowany wyłącznie z cyfr 0, 1, 2, 3, 4, 5, 6, 7, 8, 9. W kodzie mogą występować zera wiodące. Zera wiodące są istotne podczas weryfikacji kodu.
- Kod alfanumeryczny - kod jest generowany za pomocą znaków 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. Kod jest generowany i wysyłany do użytkownika za pomocą wielkich liter. Wielkość liter nie ma znaczenia podczas weryfikacji kodu.
- Zezwalaj na wiodące zera w kodzie - zezwala na wiodące zera w wygenerowanym kodzie. Dostępne tylko dla zestawu znaków Kod numeryczny.
- Zezwalaj na ponowne wysłanie kodu według identyfikatora urządzenia - umożliwia ponowne wysłanie kodu na ten sam adres e-mail poprzez powtórzenie sprawdzenia identyfikatora urządzenia. Dostępne tylko dla pojedynczych aplikacji.
- Kreator tarcz - aplikacja jest tarczą stworzoną w kreatorze: ten krok pokazuje kreator zamiast linku do płatności i przykładów kodu. Włączone dla tarcz utworzonych na stronie głównej.
- Data wydania - data, od której aplikacja jest dostępna dla zwykłych użytkowników. W połączeniu z Darmowe dla testerów beta po wydaniu określa bezpłatny okres dla urządzeń, które skontaktowały się z aplikacją przed tą datą.
- Darmowe dla testerów beta po wydaniu - długość bezpłatnego okresu (w wybranej Jednostka czasu) przyznawanego urządzeniom, których pierwsze wywołanie API nastąpiło przed Data wydania. Kody utworzone dla takich urządzeń otrzymują status Nieznany.
- Link do sprawdzenia kodu - przykładowy link do użycia w weryfikacji kodu.
- Link do płatności - link do płatności. Możesz skopiować link i wkleić go w opisie aplikacji na stronie, na której jest opublikowana. Dla każdej domeny (https://pay-to-use.com dla wszystkich języków, https://pay-to-use.ru tylko dla języka rosyjskiego) generowany jest osobny link i kod QR, dostępne jako zakładki nad polem linku. Parametry do przekazania:
- app - unikalny identyfikator aplikacji. Parametr wymagany.
- amount - kwota, która zostanie podana w polu ceny podczas zakupu. Domyślna cena jest ignorowana. Jednak kwota nie może być mniejsza niż minimalna cena i nie może być niższa niż minimalna cena ustawiona dla aplikacji. Parametr opcjonalny.
Link Link do płatności staje się publicznie dostępny dopiero po uruchomieniu aplikacji. Wcześniej użyj poniższego przycisku Płatność testowa, aby otworzyć formularz płatności z podpisanym, tymczasowym tokenem dostępu - ten sam formularz i te same metody płatności co w rzeczywistości, ale pieniądze nie są faktycznie pobierane: płatność jest tworzona bezpośrednio ze statusem Test, a w pełni działający kod (jeśli dotyczy) jest generowany i wysyłany e-mailem natychmiast, bez przechodzenia przez system płatności. Płatności testowe są widoczne na liście Płatności, oznaczone statusem Test, ale wykluczone z sum w Saldo.
Przycisk Płatność testowa otwiera rozwijaną listę wyboru domeny (https://pay-to-use.com lub https://pay-to-use.ru), na której ma zostać otwarty formularz płatności testowej - obie są w pełni funkcjonalne, wybór ma znaczenie tylko wtedy, gdy trzeba przetestować zachowanie specyficzne dla danej lokalizacji.
Aby zacząć przyjmować prawdziwe płatności, wyłącz Tryb testowy. Wcześniej upewnij się, że wszystkie wprowadzone dane są poprawne. Kluczy wygenerowanych przez aplikację nie można zmienić. Gdy tryb testowy jest włączony, obok nazwy aplikacji wyświetlana jest plakietka Test. Ponowne włączenie Tryb testowy (po potwierdzeniu) wstrzymuje przyjmowanie prawdziwych płatności i ponownie udostępnia przycisk Płatność testowa.
Weryfikacja kodu
Sprawdzenie kodu odblokowującego aplikację odbywa się w 3 krokach:
- Napisanie i wysłanie żądania weryfikacji kodu
- Sprawdzenia po stronie API
- Otrzymywanie i przetwarzanie odpowiedzi API
Wysyłanie żądania
Aby zweryfikować kod, użytkownik Twojej aplikacji musi wprowadzić go w polu w ustawieniach aplikacji.
<properties>
<property id="UnlockCode" type="string"></property>
<property id="UnlockResult" type="string">Checking...</property>
...
<properties>
<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>
Następnie należy wysłać żądanie do serwera API Pay-to-use:
function onTemporalEvent() as Void {
var ds = System.getDeviceSettings();
return Toybox.Communications.makeWebRequest(
"https://api.pay-to-use.com", // URL API
{
"device" => ds.uniqueIdentifier, // unikalny identyfikator urządzenia
"app" => "6", // identyfikator Twojej aplikacji
"model" => ds.partNumber, // numer katalogowy urządzenia
"code" => Application.Properties.getValue("UnlockCode") // wartość kodu odblokowującego w twojej aplikacji
},
{
:method => Communications.HTTP_REQUEST_METHOD_POST,
:headers => { "Content-Type" => Communications.REQUEST_CONTENT_TYPE_JSON },
:responseType => Communications.HTTP_RESPONSE_CONTENT_TYPE_JSON
},
method(:onReceive)
);
}
parametry żądania API:
- url – https://api.pay-to-use.com. Korzystanie z protokołu HTTPS jest obowiązkowe.
- Treść żądania (przekazane wartości). Słownik kluczy i wartości:
- device - unikalny identyfikator urządzenia.
- app - unikalny identyfikator twojej aplikacji.
- model – identyfikator modelu urządzenia. Parametr opcjonalny. Dane służą do wyświetlania statystyk dotyczących nowych urządzeń.
- code - kod odblokowujący wprowadzony przez użytkownika w ustawieniach twojej aplikacji.
- Opcje żądania:
- :method - API obsługuje metody żądania GET i POST.
- :headers - dla metody POST, parametry muszą być przekazywane w formacie JSON.
- :responseType - odpowiedź jest zwracana w formacie JSON.
- responseCallback - odnośnik do metody zwrotnej, która powinna przyjmować dwa argumenty:
- responseCode - kod nagłówka odpowiedzi serwera.
- data - zawartość, jeśli żądanie było udane, lub null.
Sprawdzenia po stronie API
Jeśli do API nie są przekazywane żadne parametry, API zwraca nagłówek HTTP/1.1 404 Not Found.
Jeśli przynajmniej jeden parametr jest przekazywany do API, API zwraca nagłówek HTTP/1.1 200 OK.
Odpowiedź serwera składa się z:
- response - kod odpowiedzi
- msg - tekstowy opis odpowiedzi
- expires - znacznik czasu UNIXTIME (jeśli dotyczy)
Sprawdzana jest poprawność przekazanego identyfikatora aplikacji. Aplikacja musi być w stanie Wydana w chwili płatności. W przypadku błędu zwracany jest kod odpowiedzi 301.
Jeśli przesłano unikalny identyfikator urządzenia, identyfikator urządzenia jest wyszukiwany i przechowywany. W przypadku wystąpienia błędów podczas sprawdzania lub zapisywania, zwracany jest kod błędu 402. Jeśli zostanie znaleziony taki kod zwrotny, natychmiast napisz do pomocy technicznej pod adresem [email protected]
Jeśli kod zostanie przekazany, następujące kroki są wykonywane dla aplikacji z metodami obliczania Obliczanie ceny w zależności od okresu i Obliczanie okresu w zależności od ceny:
- Jeśli przesłany zostanie pusty kod, zostaje on odłączony od unikalnego identyfikatora urządzenia zdefiniowanego w poprzednich krokach.
- Jeśli zostanie przesłany niepusty kod i nie jest on aktywowany, kod jest aktywowany w zależności od warunków ceny określonych podczas zakupu kodu, niezależnie od daty aktywacji.
- Jeśli nie zostanie przesłany żaden kod lub jeśli przesłany kod nie zostanie znaleziony, zwracany jest kod błędu 201.
- Sprawdzany jest aktywowany kod w porównaniu z urządzeniem i w przypadku przekazania podczas aktywacji innego unikalnego identyfikatora urządzenia niż przechowywany, zwracany jest kod błędu 202.
- Jeśli przesłany kod nie ma daty wygaśnięcia i wszystkie poprzednie sprawdzenia zostały zaliczone, zwracany jest kod 101.
- Jeśli kod ma ograniczony czas ważności, następuje sprawdzenie. Jeśli klucz nie wygasł, zwracany jest kod 101. Jeśli kod wygasł, zwracany jest kod błędu 203.
- Ten rodzaj aplikacji wymaga, aby kod był przypisany do urządzenia. Jeśli nie przesłano unikalnego identyfikatora urządzenia, zwracany jest kod błędu 304.
Dla aplikacji z Stały kod, sprawdzana jest tylko dostępność kodu w chwili zakupu. Jeśli kod zostanie znaleziony, zwracany jest kod 101. Jeśli kod nie zostanie znaleziony, zwracany jest kod błędu 201.
Dla aplikacji z metodą obliczania Darowizna, kod nie jest sprawdzany. Zawsze zwracany jest kod 101.
Jeśli przesłano pusty kod, a w aplikacji wypełniono pole Data wydania, sprawdzany jest okres dla beta testerów: jeśli urządzenie po raz pierwszy połączyło się z API przed datą wydania, a okres Darmowe dla testerów beta po wydaniu jeszcze się nie skończył, zwracany jest kod 103.
Jeśli opcja Zezwalaj na ponowne wysłanie kodu według identyfikatora urządzenia jest włączona i nie przesłano kodu, wyszukiwany jest prawidłowy kod już przypisany do urządzenia. Jeśli zostanie znaleziony, zwracany jest kod 101 razem z samym kodem.
Jeśli poprzednie sprawdzenia nie zostały zaliczone, sprawdzany jest okres testowy. Jeśli upłynęło więcej czasu od pierwszego skontaktowania się z urządzeniem niż bieżące ustawienia aplikacji, zwracany jest kod błędu 204. Jeśli okres próbny nie wygasł jeszcze, zwracany jest kod błędu 102.
Jeśli przesłano tylko identyfikator aplikacji i ani kod odblokowujący, ani unikalny identyfikator urządzenia nie został przesłany, zwracany jest kod błędu 303.
Jeśli zwrócony zostanie kod odpowiedzi 500, powinieneś napisać do wsparcia pod adresem [email protected]
Poniżej znajduje się tabela wszystkich zwróconych kodów:
| Kod | Wiadomość |
|---|---|
| 101 |
Metody obliczania Obliczanie ceny w zależności od okresu i Obliczanie okresu w zależności od ceny:
|
| |
Stały kod:
| |
Darowizna:
| |
| 102 | |
| 103 | |
| 201 | |
| 202 | |
| 203 | |
| 204 | |
| 301 | |
| 302 | |
| 303 | |
| 304 | |
| 401 | |
| 402 | |
| 500 | |
Sprawdzanie odpowiedzi
Następnie powinieneś sprawdzić odpowiedź serwera API Pay-to-use:
function onReceive(responseHeader, data) as Void {
if (responseHeader == 200) { Toybox.Background.exit(data); }
}
Możesz sprawdzić wszystkie nagłówki i kody, możesz wyświetlać własne komunikaty dla wygody użytkownika, ale w najprostszej formie weryfikacja będzie wyglądać mniej więcej tak:
function onBackgroundData(data) as Void {
if (data.hasKey("response")) {
if (data.hasKey("msg")) {
// Możesz wyświetlić data["msg"] w polu właściwości pod nazwą "UnlockResult".
Application.Properties.setValue("UnlockResult", data["msg"]);
}
if (data["response"].toString().substring(0, 1).equals("2")) {
// Weryfikacja kodu nie powiodła się
// Płatne funkcje NIE są dostępne
...
} else {
// Sprawdzenie kodu zakończyło się sukcesem lub błąd jest Twoją winą lub winą interfejsu API
// Płatne funkcje są dostępne
...
}
}
}Kody odblokowujące
Po przejściu do tej sekcji otworzy się lista kodów odblokowujących.
Lista kodów odblokowujących
Możesz wyszukiwać w polu adresu e-mail lub kodu w górnym pasku wyszukiwania. Znalezione kody będą wyświetlane na liście. Możesz używać całego lub części adresu e-mail lub kodu jako kryterium wyszukiwania. Dopasowania będą wyróżnione kolorem. Wyszukiwanie i filtry działają jednocześnie i nie wykluczają się nawzajem.
Ostatnio używany filtr jest przechowywany dla użytkownika. To znaczy, że kolejnym razem, gdy wejdziesz na stronę, ostatnio używany filtr zostanie automatycznie zastosowany. Filtry są dostępne dla listy kodów odblokowujących:
- Kolumny - wybierz kolumny tabeli do wyświetlenia na liście kodów odblokowujących.
- Aplikacja - wyświetlaj tylko kody odblokowujące dla wybranych aplikacji.
- Status - wyświetlaj tylko kody odblokowujące znajdujące się w wybranych statusach.
Lista kolumn w tabeli kodów odblokowujących:
- Aplikacja - Twoja aplikacja. Możesz kliknąć link, aby edytować jej ustawienia.
- Kod - kod odblokowujący.
- E-mail - adres e-mail powiązany z rejestracją kodu odblokowującego. Ten adres jest używany do wyszukiwania kodów odblokowujących klientów w sekcji Moje zakupy na stronie internetowej. Ta sekcja jest dostępna dla użytkowników.
- Okres - okres ważności wysłanego kodu (określony w ustawieniach aplikacji). Okres ważności jest ustawiony dla kodu, odpowiadający warunkom ustawień aplikacji w momencie jej utworzenia.
- Status - status kodu odblokowującego. (zobacz Status kodu odblokowującego)
- Utworzony - data utworzenia kodu odblokowującego.
- Język - język użytkownika, używany w wiadomościach z kodem.
- Aktywacja - data aktywacji kodu. Jest ustawiana w momencie, gdy to konkretne urządzenie użytkownika po raz pierwszy kontaktuje się z usługą API PayToUse i przesyła ten kod. Status kodu zmienia się na Aktywowany. Tylko nieaktywny kod może być aktywowany. Jeśli aktywny kod zostanie przesłany przez urządzenie z innym identyfikatorem, API zwróci błąd 202. Tylko jedno urządzenie może być połączone z pojedynczym kodem.
- Wygaśnięcie - data wygaśnięcia aktywacji kodu. Ustawiona dla kodów, które mają ograniczony okres ważności po aktywacji kodu. Dla kodów z nieograniczonym terminem ważności data pozostaje pusta.
- Usunięty - data usunięcia kodu. Po usunięciu status kodu jest ustawiony na Nieznany.
- Urządzenie - unikalny identyfikator urządzenia, do którego przypisany jest kod.
- Pierwsze połączenie urządzenia - data pierwszego wywołania API z urządzenia. Od tej daty liczony jest okres próbny i okres dla beta testerów.
- Ostatnie połączenie urządzenia - data ostatniego wywołania API z urządzenia. Pozwala sprawdzić, czy aplikacja jest nadal używana.
- Płatność nr - unikalny numer sekwencji płatności. Możesz kliknąć na link, aby zobaczyć szczegóły płatności.
- Notatki - notatki wprowadzone podczas ręcznego tworzenia kodów.
- Przyciski do działań z kodami odblokowującymi. Na przykład, usuwanie.
Status kodu odblokowującego
Podczas swojego cyklu życia kod odblokowujący przechodzi przez różne stany, które można śledzić za pomocą statusu kodu.
| Status | Opis |
|---|---|
| Dostępny | Status jest przypisywany do kodu odblokowującego, dla którego nie wykonano żadnych działań lub dla którego zresetowano powiązanie z urządzeniem. |
| Aktywowany | Status jest ustawiany dla kodu z ustawioną datą aktywacji. Data aktywacji jest ustawiana, gdy urządzenie po raz pierwszy pomyślnie uzyskuje dostęp do usługi API PayToUse. Ponadto, podczas aktywacji kodu ustawiana jest data wygaśnięcia kodu. |
| Wygasły | Status jest ustawiany dla wygasłego kodu. Odłączenie kodu od urządzenia nie resetuje daty wygaśnięcia kodu. Sprawdzanie kodu z tym statusem zwróci błąd 203. (zobacz Sprawdzenia po stronie API) |
| Nieznany | Status jest ustawiany, gdy kod jest usunięty. Sprawdzanie kodu z tym statusem zwróci błąd 201. (zobacz Sprawdzenia po stronie API) |
| Nieznany | Status jest ustawiany dla kodu utworzonego dla urządzenia, którego pierwsze wywołanie API nastąpiło przed Data wydania aplikacji - zamiast zwykłego okresu próbnego lub płatnej aktywacji przyznawany jest okres bezpłatny, skonfigurowany przez Darmowe dla testerów beta po wydaniu. |
| Nieznany | Status jest ustawiany dla kodu współdzielonego przez kilka zgrupowanych aplikacji. Nie jest powiązany z pojedynczą aplikacją i nie pojawia się na liście kodów poszczególnych aplikacji w grupie. |
| Nieznany | To samo co Nieznany, ale kod nie jest już dostępny: został usunięty lub, w przypadku grupy z kluczem tylko dla jednej aplikacji, został już aktywowany w jednej z aplikacji grupy. Usunięcie kodu grupy usuwa także jego kopie we wszystkich aplikacjach grupy. |
| Nieznany | Status jest ustawiany dla kodu należącego do aplikacji w ramach grupy, gdy zostaje on usunięty indywidualnie, podczas gdy sam kod grupy pozostaje. |
Szczegóły kodu
Kliknięcie kodu na liście otwiera stronę szczegółów kodu. Pokazuje ona te same pola co lista oraz przyciski działań z kodem:
- Resetuj - odłącza kod od urządzenia i resetuje datę aktywacji. Status kodu zmienia się na Dostępny, a kod można aktywować na innym urządzeniu, na przykład gdy użytkownik wymienił urządzenie. Data wygaśnięcia już aktywowanego kodu nie jest resetowana. Przycisk jest niedostępny dla aplikacji z kodami tymczasowymi, ponieważ taki kod może być używany tylko na jednym urządzeniu.
- Aktywuj - dostępne dla kodu tymczasowego, który nie został jeszcze opłacony. Wprowadź email użytkownika i okres ważności kodu: kod zostanie aktywowany dla urządzenia, do którego jest przypisany, tak jakby został opłacony. Użyj tego na przykład, aby przekazać użytkownikowi aplikację za darmo.
- Wyślij kod - wysyła wiadomość email z kodem i jego szczegółami na email kodu. Wybierz Język wiadomości. Jeśli zaznaczono Wyślij kopię do dewelopera, kopia wiadomości jest wysyłana na kontaktowy email aplikacji. Użyj tego, gdy użytkownik zgubił wiadomość z kodem.
- Zmień e-mail - zmienia email kodu. W przypadku kodu grupy email zmienia się dla kodu grupy i wszystkich jego kopii. Jeśli kod został otrzymany w wyniku płatności, zmienia się także email płatności. Użytkownik znajdzie wtedy kod w sekcji Moje zakupy pod nowym adresem email.
- Usuń - usuwa kod. Status kodu zmienia się na Nieznany, a weryfikacja kodu zwraca błąd 201. Nieopłacony kod tymczasowy jest usuwany całkowicie.
Działania z kodem są dostępne także na stronie szczegółów płatności, jeśli dla płatności wysłano kod.
Utwórz
Przycisk Utwórz na pasku tytułu listy kodów odblokowujących otwiera formularz tworzenia kodów bez płatności. Na przykład dla beta testerów, recenzentów lub użytkowników, którzy zapłacili w inny sposób. Pola formularza:
- E-mail - adres, na który wysyłane są utworzone kody. Kopia wiadomości jest wysyłana na kontaktowy email aplikacji.
- Aplikacja - aplikacja, dla której tworzone są kody. Dostępne są tylko aplikacje o statusach Test i Uruchom z metodą obliczania ceny Obliczanie ceny w zależności od okresu lub Obliczanie okresu w zależności od ceny.
- Okres i Jednostka czasu - okres ważności kodów. Liczy się od momentu aktywacji kodu na urządzeniu.
- Liczba - liczba kodów do utworzenia.
- Notatki - dowolny tekst zapisywany razem z kodami. Wyświetlany w kolumnie Notatki listy.
- Dodaj notatki do wiadomości e-mail - dodaje notatki do wiadomości z kodami.
Kody są generowane zgodnie z ustawieniami kodu aplikacji (długość i zestaw znaków). Po zapisaniu wyświetlana jest lista utworzonych kodów i wysyłana jest wiadomość.
Wczytaj
Przycisk Wczytaj pozwala wczytać kody wydane poza PayToUse, na przykład przy przejściu z innego systemu licencjonowania. Wybierz aplikację, plik i parametry pliku:
- Format pliku - CSV, kodowanie UTF-8. Maksymalny rozmiar pliku jest podany w formularzu wczytywania.
- zawiera nagłówki - zaznacz, jeśli pierwszy wiersz pliku zawiera nazwy kolumn. Pierwszy wiersz jest wtedy pomijany.
- Separator - średnik, przecinek lub tabulator.
Kolumny pliku w tej kolejności:
- Kod - kod odblokowujący, wymagany. Jest zamieniany na wielkie litery i przycinany do 12 znaków. Kody, które już istnieją dla aplikacji, są pomijane.
- E-mail - email użytkownika.
- Utworzony - data utworzenia: data lub znacznik czasu UNIXTIME. Jeśli puste, używana jest data wczytania.
- Wygaśnięcie - data wygaśnięcia: data lub znacznik czasu UNIXTIME. Pozostaw puste, jeśli kod nie został jeszcze aktywowany lub nie ma daty wygaśnięcia.
- Okres - okres ważności po aktywacji: liczba i jednostka, na przykład 12h, 30d, 6m lub 1y. Jeśli puste, kod jest ważny bezterminowo.
Po wczytaniu wyświetlana jest tabela wczytanych wierszy. Niewczytane wiersze są podświetlone na czerwono, a komunikat pokazuje, ile wierszy dodano z ogólnej liczby. Podczas wczytywania wiadomości do użytkowników nie są wysyłane.
Pobierz
Przycisk Pobierz pobiera listę kodów odblokowujących do pliku CSV. W formularzu wybierz pola, które mają znaleźć się w pliku. Plik zawiera wszystkie kody pasujące do bieżących filtrów i wyszukiwania, a nie tylko kody z bieżącej strony. Wybrane pola są zapamiętywane do następnego pobrania.
Płatności
Po przejściu do tej sekcji otworzy się lista płatności użytkownika.
Do otrzymywania płatności używane są następujące systemy płatności:
Po opłatach systemu płatności PayToUse pobierze opłatę w wysokości 13%. Nieustannie pracujemy nad obniżeniem opłat.
W przypadku jakichkolwiek sporów lub zwrotów w systemie płatności kary systemu płatności są przenoszone na dewelopera. Dlatego nie należy dopuszczać do takich sytuacji. W sytuacjach spornych opłata PayToUse nie jest pobierana.
Lista płatności
Możesz wyszukiwać w polu e-mail lub wysłanym kodzie w górnym pasku wyszukiwania. Znalezione płatności zostaną wyświetlone na liście. Możesz użyć całego lub części adresu e-mail lub wysłanego kodu jako kryterium wyszukiwania. Dopasowania będą podświetlone kolorem. Wyszukiwanie i filtry działają jednocześnie i się wzajemnie nie wykluczają.
Ostatnio używany filtr jest przechowywany dla użytkownika. Oznacza to, że następnym razem, gdy wejdziesz na stronę, ostatnio używany filtr zostanie automatycznie zastosowany. Filtry są dostępne dla listy płatności:
- Kolumny - wybierz kolumny tabeli do wyświetlenia na liście płatności.
- Okres - pokazuj tylko płatności utworzone w wybranym zakresie dat.
- Aplikacja - wyświetlanie płatności tylko z wybranych aplikacji.
- System - wyświetlaj płatności tylko z wybranych systemów płatności.
- Status - wyświetlaj płatności tylko z wybranymi statusami.
Lista kolumn w tabeli płatności:
- Aplikacja - Twoja aplikacja. Możesz kliknąć link, aby edytować jej ustawienia.
- # - unikalny numer sekwencyjny płatności. Jest on przypisywany automatycznie po przejściu użytkownika z formularza płatności na stronę płatności w systemie płatności. Możesz kliknąć na link, aby zobaczyć szczegóły płatności.
- Komentarze - wiadomość od użytkownika wprowadzona w formularzu płatności.
- System - system płatności wybrany przez użytkownika.
- Status - status płatności. (zobacz Status płatności)
- E-mail - e-mail użytkownika podany w formularzu płatności.
- Okres - okres ważności wysłanego kodu (określony w ustawieniach aplikacji).
- Język - język formularza płatności wybrany przez użytkownika.
- Utworzony - data utworzenia płatności.
- Kwota faktury - kwota płatności pobrana od użytkownika. Określana w formularzu płatności w zależności od ustawień aplikacji.
- Data płatności - data płatności.
- Kwota płatności - kwota płatności potwierdzona przez system płatności.
- Wysłany kod - kod wysłany do użytkownika.
- Dostępna kwota - dostępna kwota wypłaty.
- Kwota wypłaty - kwota wypłaconych środków za płatność.
Szczegóły płatności
Kliknięcie # płatności na liście otwiera jej stronę ze szczegółami.
Oprócz pól wymienionych powyżej, strona ze szczegółami pokazuje:
- Kod - kod wprowadzony przez kupującego w formularzu płatności, przed jego sprawdzeniem i aktywacją. Wyświetlany tylko dla aplikacji z kodami tymczasowymi powiązanymi z urządzeniem.
- Kwota płatności (brutto) - kwota potwierdzona przez system płatności, przed uwzględnieniem opłat systemu płatności i PayToUse.
- Kwota płatności (netto) - kwota potwierdzona przez system płatności, po uwzględnieniu opłat systemu płatności i PayToUse.
-
Identyfikatory płatności - identyfikatory nadane przez system płatności, używane w razie potrzeby do wyszukania płatności w tym systemie. Wyświetlane pola zależą od systemu płatności:
- Stripe: Payment Intent, Numer paragonu, Ostatnie 4 cyfry.
- PayPal: ID płatności, ID płacącego, ID transakcji.
- Robokassa: ID płatności, ID1, ID2.
Jeśli dla płatności wysłano kod, na stronie szczegółów płatności dostępne są przyciski Resetuj kod, Wyślij kod i Zmień e-mail. Działają tak samo jak na stronie szczegółów kodu. (zobacz Szczegóły kodu)
Status płatności
Podczas swojego cyklu życia płatność przechodzi przez różne stany, które można śledzić za pomocą statusu płatności.
| Status | Opis |
|---|---|
| Niekompletny | Status jest przypisany do płatności, dla których nie wykonano żadnych działań. Płatność jest tworzona, gdy użytkownik przełącza się z formularza płatności na formularz systemu płatności. Płatności przypisany jest unikalny numer seryjny, a także podstawowe atrybuty płatności: kwota, system płatności, data. |
| Zakończony sukcesem | Status jest przypisany do płatności, które otrzymały pozytywną odpowiedź od systemu płatności. Kolejnym krokiem jest wysłanie użytkownikowi wiadomości e-mail zawierającej wygenerowany kod lub inne dane, w zależności od ustawień aplikacji. Jeśli płatność pozostanie w tym statusie, konieczne jest poświęcenie jej szczególnej uwagi, ponieważ kolejne działania nie zostały wykonane. |
| Błąd | Status jest przypisany do płatności, dla których otrzymano negatywną odpowiedź od systemu płatności. Następne kroki nie są wykonywane. Konieczne jest poświęcenie szczególnej uwagi takim płatnościom, ponieważ status po stronie systemu płatności może być przetwarzany z opóźnieniem. |
| Oczekujący | Status jest przypisany do płatności, dla których otrzymano pozytywną odpowiedź od systemu płatności, a wszystkie kolejne kroki zostały wykonane pomyślnie. Wypłata dla płatności o tym statusie nie jest dostępna. Płatności przenoszone są automatycznie do następnego statusu po 7 dniach. |
| Dostępny | Wypłata jest dostępna dla płatności o tym statusie. |
| Wysyłanie | Status jest przypisywany do płatności uwzględnionych w następnej wypłacie. Jeśli wypłata zostanie anulowana lub odrzucona, status płatności zostanie przywrócony do Dostępny. |
| Wysłany | Status jest przypisywany do płatności, dla których dokonano wypłaty. Oczekuje się na potwierdzenie otrzymania środków. |
| Zakończony | Status jest przypisywany do płatności z udanymi wypłatami. Można ręcznie ustawić status, potwierdzając wypłatę w odpowiednim dziale. Status jest również automatycznie zmieniany po 14 dniach od wypłaty płatności. |
| Zwrócony | Płatności, dla których wystawiono zwrot, są przenoszone do tego statusu. Przy wystawianiu zwrotu pobierana jest opłata za zwrot. Opłata jest odliczana od kwoty wypłaty. |
| Zwrot zamknięty | Zwrot, który został uwzględniony w już wysłanej wypłacie. Opłata za zwrot jest w takim przypadku pobierana z salda dewelopera, ponieważ wypłaconej kwoty nie można już zmniejszyć. |
| Spór | Kupujący zakwestionował płatność (chargeback) w systemie płatności. Sprawa oczekuje na rozstrzygnięcie. |
| Spór zakończony | Spór został rozstrzygnięty. Podobnie jak w przypadku zwrotu, wszelkie opłaty za spór pobierane przez system płatności są przenoszone na dewelopera. |
| Anulowany | Płatność została anulowana przed jej zakończeniem. |
| Nieznany | Przypisywane podczas uzgadniania zapisów płatności z raportem systemu płatności, którego tekst statusu nie odpowiada żadnemu ze znanych powyżej statusów. Wymaga ręcznego przeglądu. |
| Test | Płatność testowa dokonana za pomocą Tryb testowy aplikacji, gdy znajduje się ona w statusie Test, zanim zostanie uruchomiona. Kwota i wygenerowany kod są prawdziwe, ale pieniądze nie są faktycznie pobierane, a płatność jest wykluczona z sum w panelu. |
Pobierz
Przycisk Pobierz na pasku tytułu listy płatności pobiera listę do pliku Excel (XLSX). Plik zawiera kolumny wybrane w filtrze Kolumny, w tej samej kolejności, oraz wszystkie płatności pasujące do bieżących filtrów i wyszukiwania, a nie tylko płatności z bieżącej strony.
Wypłaty
Po przejściu do tej sekcji otworzy się lista twoich wypłat.
Wypłać
Przycisk „Wypłać” służy do złożenia wniosku o przelanie zgromadzonych środków.
Po kliknięciu tego przycisku otworzy się okno modalne, w którym należy podać szczegóły płatności dotyczące przelewu.
Ważna uwaga: System automatycznie wykorzystuje do wypłaty całą dostępną kwotę wskazaną w odpowiednim polu. Nie można podać dowolnej kwoty niższej niż dostępne saldo. Łączna kwota wypłaty stanowi sumę wszystkich płatności o statusie „dostępne do wypłaty”.
W oknie modalnym możesz wybrać kwotę i walutę wypłaty. Dostępne waluty zależą od posiadanych metod płatności.
Uwaga: Jeśli wybrana waluta nie jest obsługiwana przez wybraną metodę wypłaty, zlecenie wypłaty zostanie odrzucone.
Lista wypłat
Ostatnio używany filtr jest przechowywany dla użytkownika. Oznacza to, że następnym razem, gdy wejdziesz na stronę, ostatnio używany filtr zostanie automatycznie zastosowany. Dla listy wypłat są dostępne filtry:
- Kolumny - wyświetlaj tylko wybrane kolumny na liście wypłat.
- Status - wyświetlaj tylko wypłaty znajdujące się w wybranych statusach.
Lista kolumn w tabeli wypłat:
- # - unikalny numer sekwencyjny wypłaty. Przypisywany jest automatycznie po zapisaniu wypłaty. Możesz kliknąć na link, aby wyświetlić szczegóły wypłaty.
- Status - status wypłaty. (zobacz Status wypłaty)
- Utworzony - data żądania wypłaty.
- Kwota - kwota wypłaty.
- Wypłata - data wysłania wypłaty.
- Przyciski do działań z wypłatami. Na przykład, potwierdzenie.
Możesz potwierdzić wypłatę, gdy znajduje się w statusie Wysłany.
Szczegóły wypłaty
Kliknięcie # wypłaty na liście otwiera stronę jej szczegółów. Oprócz pól listy pokazuje ona Szczegóły - dane płatnicze podane we wniosku o wypłatę, na które przekazywane są środki.
Poniżej znajduje się lista płatności objętych wypłatą. Dostępne są dla niej filtry Kolumny, Aplikacja, System i Status, tak jak na liście płatności. (zobacz Lista płatności)
Status wypłaty
Podczas swojego cyklu życia, wypłata przechodzi przez różne stany, które można śledzić za pomocą statusu wypłaty.
| Status | Opis |
|---|---|
| Oczekujący | Status jest przypisywany do wypłat w chwili utworzenia, gdy nie wykonano jeszcze żadnych działań. |
| Anulowany | Status jest przypisywany do anulowanych wypłat. Anulowania mogą być przeprowadzane z różnych powodów. Na przykład, nie jest określony sposób otrzymywania środków. Wszystkie płatności z tej wypłaty przechodzą do stanu Dostępny i są ponownie dostępne do wypłaty. |
| Wysłany | Status jest ustawiany dla wypłaty środków, gdy zostanie wysłana. |
| Zakończony | Status jest ustawiany ręcznie, gdy deweloper potwierdzi otrzymanie środków, lub automatycznie po 14 dniach od wysłania. |
| Odrzucony | Status jest ustawiany dla wypłaty, gdy bank lub system płatności zwraca środki po wysłaniu. Wszystkie płatności z tej wypłaty przechodzą do stanu Dostępny i są ponownie dostępne do wypłaty. |
Kreator tarcz
Kreator tworzy tarcze Garmin Connect IQ dla Twojej aplikacji bez programowania. Rozmieszczasz elementy na ekranie każdego modelu zegarka, wybierasz, co pokazują i które z nich są płatne, i pobierasz gotowy plik: .prg do zainstalowania na własnym zegarku w celu sprawdzenia lub .iq do publikacji w Connect IQ Store.
Gotowa tarcza sama sprawdza płatność przez PayToUse zgodnie z metodą płatności aplikacji. Nie musisz pisać kodu.
Kreator otwiera się przyciskiem z rakietą obok nazwy aplikacji na stronie aplikacji.
Klucz dewelopera Connect IQ
Każdy plik .prg i .iq jest podpisywany kluczem dewelopera — prywatnym kluczem RSA 4096 bitów. Ustawia się go raz w Profilu i jest używany dla wszystkich tarcz dewelopera.
- Jeśli masz już aplikacje w Connect IQ Store, prześlij klucz, którym je podpisano: plik developer_key utworzony przez Connect IQ SDK (na przykład poleceniem "Monkey C: Generate a Developer Key" w Visual Studio Code). Aplikację opublikowaną w sklepie można zaktualizować tylko tym samym kluczem.
- Jeśli nie masz jeszcze klucza, wygeneruj go przyciskiem „Wygeneruj nowy klucz”. Taki klucz nadaje się do instalowania tarcz na zegarku i do nowych aplikacji w sklepie, ale aplikacji opublikowanych już z innym kluczem nie można nim zaktualizować.
- Pobierz klucz i przechowuj kopię w bezpiecznym miejscu. Jeśli klucz zostanie utracony, aplikacji opublikowanych z jego użyciem nie będzie można już zaktualizować w sklepie.
- Akceptowane są pliki w formacie DER lub PEM. Klucz nie może być chroniony hasłem.
Ważne: zmiana klucza dotyczy wszystkich tarcz dewelopera. Poprzedni klucz jest przechowywany na serwerze, ale nowe kompilacje są podpisywane nowym.
Modele zegarków
Listę modeli dostępnych w kreatorze ustala administrator na stronie Modele zegarków: okrągłe i prostokątne modele z Connect IQ 4 i nowszym. W kreatorze modele dla tarczy wybiera się przyciskiem Modele.
Każdy model ma własny układ: położenie, rozmiar i czcionkę elementów ustawia się osobno, a lista elementów, funkcje i ustawienia płatności są wspólne dla wszystkich modeli. Nowo dodany model otrzymuje układ bieżącego modelu przeskalowany do jego ekranu.
- Zegarek / Ekran - pokaż ekran na obrazie zegarka lub tylko ekran.
- Rzeczywisty rozmiar - pokaż zegarek w rzeczywistym rozmiarze.
- Always On - podgląd trybu Always On ekranów AMOLED.
Elementy
Tarcza składa się z elementów czterech typów:
- Tekst - pokazuje wartość funkcji: czas, datę, kroki, tętno, pogodę itd.
- Stały tekst - tekst, który wpisujesz samodzielnie.
- Wskazówki - analogowe wskazówki godzinowa, minutowa i sekundowa.
- Obraz - obraz: tło lub warstwa nad innymi elementami.
Elementy są rysowane w kolejności listy na karcie Elementy: pierwszy to najniższa warstwa. Kolejność zmienia się strzałkami na liście oraz przyciskami Na spód i Na wierzch.
Elementy przesuwa się myszą lub strzałkami na klawiaturze (o 1 px, z Shift o 10 px). Ctrl+D duplikuje element, Ctrl+C / Ctrl+V kopiują jego położenie do innego modelu, Delete usuwa. Przycisk Kopiuj do wszystkich modeli przenosi położenie elementu do wszystkich wybranych modeli. Przycisk Kopiuj wszystko do wszystkich modeli zastępuje układy wszystkich pozostałych modeli układem bieżącego modelu: wszystkie elementy i tło, przeskalowane do każdego ekranu.
Funkcje i płatność
Element tekstowy może mieć kilka funkcji. Jedna z nich jest pokazywana domyślnie; jeśli włączono Użytkownik może wybrać funkcję w ustawieniach, użytkownik zegarka wybiera funkcję w ustawieniach tarczy w Garmin Connect.
Każdą funkcję każdego elementu można oznaczyć jako płatną: ta sama funkcja może być bezpłatna w jednym elemencie i płatna w innym. Karta Funkcje pokazuje wszystkie używane funkcje i elementy w jednej tabeli.
Funkcje oznaczone gwiazdką wymagają dodatkowego uprawnienia (historia czujników, profil użytkownika lub lokalizacja), które sklep pokazuje podczas instalacji tarczy. Uprawnienie jest dodawane do tarczy tylko wtedy, gdy używa ona takich funkcji. Wschód i zachód słońca oraz ikony dzień/noc wymagają lokalizacji: ostatniej pozycji GPS zegarka (aktualizowanej przez każdą aktywność z GPS), a w razie jej braku lokalizacji prognozy pogody.
Bez płatności tarcza zachowuje się zależnie od metody płatności aplikacji:
| Metoda płatności | Bez płatności |
|---|---|
| Obliczanie ceny w zależności od okresu, Obliczanie okresu w zależności od ceny, Stały kod | Płatne funkcje pokazują „paid”, płatne obrazy są ukrywane. Kod odblokowania wpisuje się w ustawieniach tarczy; kod QR strony zakupu znajduje się w menu ustawień na zegarku. |
| Kod tymczasowy z ceną zależną od okresu, Kod tymczasowy z okresem zależnym od ceny | Jeśli tarcza używa płatnych funkcji, pokazuje ekran blokady z kodem zegarka i kodem QR strony płatności. |
| Darowizna | Płatność nie jest sprawdzana, oznaczenia płatności są ignorowane. |
Na ekranach dotykowych dotknięcie zablokowanej tarczy odblokowuje wszystkie funkcje na 15 minut w ramach próby.
Ikony
Element tekstowy może pokazywać ikonę obok wartości funkcji. Ikona należy do funkcji w całej tarczy: zmienia się ją w kolumnie Ikona tabeli funkcji elementu lub na karcie Funkcje, a zmiana dotyczy wszystkich elementów z tą funkcją.
- Ze słownika (domyślnie) - ikona, którą administrator ustawił dla tej funkcji w słowniku ikon.
- Bez ikony - funkcja jest pokazywana bez ikony.
- Jedna ikona - dowolna ikona ze wspólnej biblioteki lub z Twoich własnych ikon.
- Zestaw - ikona zależy od wartości funkcji: używany jest pierwszy wiersz, którego wartość „do” nie jest mniejsza od wartości, ostatni wiersz dotyczy wszystkich większych wartości. Z „Dzień / noc” każdy wiersz ma własną ikonę nocną, używaną od zachodu do wschodu słońca.
Wartości dla zestawów: bateria - naładowanie w %, alarmy - ich liczba, połączenie z telefonem i nie przeszkadzać - 1 lub 0, księżyc - wiek w dniach, wiatr - kierunek w stopniach, pogoda - kod stanu; pozostałe funkcje - ich liczba bez jednostek. Podczas ładowania ikony baterii są pokazywane po kolei.
Ustawienie elementu Pokaż wybiera tekst i ikonę, tylko tekst lub tylko ikonę. Położenie ikony względem tekstu, jej rozmiar, kolor, odstęp i przesunięcie ustawia się w układzie każdego modelu. Wyrównanie elementu dotyczy całego bloku: tekstu, odstępu i ikony razem.
Własne ikony dodaje się na karcie Tarcza w sekcji Ikony tarczy: pliki SVG (kilka naraz) lub czcionkę TTF, której każdy znak staje się ikoną. Wymagania dla SVG:
- ikony są jednokolorowe: kolory pliku są ignorowane, ikona jest rysowana kolorem wybranym w kreatorze;
- używane są tylko wypełnione kształty; linie bez wypełnienia (stroke) trzeba zamienić na kształty w edytorze wektorowym (na przykład „Kontur na ścieżkę” w Inkscape lub „Outline Stroke” w Figma i Illustrator);
- otwory muszą być prawdziwymi wycięciami (ścieżka złożona lub reguła wypełnienia evenodd): biały kształt na czarnym staje się wypełnionym obszarem;
- rozmiar ikony to viewBox pliku; gradienty, maski, tekst i klasy CSS nie są obsługiwane.
Na zegarku ikony są zamieniane na bitmapy potrzebnego rozmiaru podczas kompilacji tarczy.
Czcionki i obrazy
- Czcionki systemowe zegarka są dostępne dla każdego modelu. Czcionki cyfrowe zawierają tylko cyfry i kilka znaków.
- Własne czcionki TTF lub OTF przesyła się na karcie Tarcza i są zamieniane na bitmapy dla każdego modelu i rozmiaru. Model może mieć łącznie do 12 różnych rozmiarów własnych czcionek i ikon.
- Obrazy (PNG, JPEG, GIF, WebP do 2000×2000) przesyła się na tej samej karcie. Obraz wypełnia ekran dowolnego modelu albo ma własny rozmiar; jest skalowany dla każdego modelu, przezroczystość zostaje zachowana. Do 8 różnych obrazów lub rozmiarów na model.
- Obrazy zajmują pamięć graficzną zegarka; kreator pokazuje, ile jej jest zajęte w bieżącym modelu.
Tryb Always On
Na ekranach AMOLED w trybie Always On tarcza pokazuje tylko elementy z opcją Pokazuj w trybie Always On, na czarnym tle i z niewielkim przesunięciem co minutę dla ochrony ekranu. Garmin dopuszcza w tym trybie najwyżej 10% świecących pikseli; kreator pokazuje tę wartość nad ekranem. Sekundy i wskazówka sekundowa nie są w tym trybie wyświetlane.
Kompilacja
- Zbuduj dla tego zegarka (.prg) - plik dla bieżącego modelu do zainstalowania na zegarku.
- Zbuduj dla Connect IQ Store (.iq) - pakiet dla wszystkich wybranych modeli do publikacji w Connect IQ Store. Każda kompilacja .iq otrzymuje nowy numer wersji.
Kompilacje trafiają do kolejki i zwykle trwają około minuty. Karta Kompilacje pokazuje stan, link do pobrania i dziennik kompilacji.
UUID aplikacji na karcie Tarcza identyfikuje aplikację w sklepie. Nie zmieniaj go między wersjami. Aby zaktualizować już opublikowaną aplikację, wpisz jej UUID.
Instalowanie pliku .prg na zegarku
Podłącz zegarek do komputera kablem USB i skopiuj plik .prg do folderu GARMIN/Apps zegarka. Po odłączeniu kabla tarcza pojawi się na liście tarcz w zegarku.
- Windows: zegarek pojawia się w Eksploratorze plików jako urządzenie (na przykład "fēnix 7"). Otwórz Internal Storage → GARMIN → Apps i skopiuj tam plik.
- macOS: większość nowoczesnych zegarków łączy się przez MTP, którego macOS nie obsługuje bez dodatkowego oprogramowania. Zainstaluj OpenMTP (bezpłatny), podłącz zegarek, otwórz GARMIN/Apps i skopiuj tam plik. Wcześniej zamknij Garmin Express, w przeciwnym razie przejmie on połączenie.
- Linux: zegarek pojawia się w menedżerze plików (GNOME Files, Dolphin) jako urządzenie MTP; otwórz GARMIN/Apps i skopiuj tam plik. Bez środowiska graficznego zegarek można zamontować za pomocą jmtpfs lub simple-mtpfs.
Aby usunąć tarczę, usuń plik z GARMIN/Apps lub usuń ją na zegarku.
Uwaga: ustawień tarczy zainstalowanej w ten sposób nie można zmienić w aplikacji Garmin Connect, używa ona ustawień domyślnych. Aby przetestować ustawienia, opublikuj tarczę w sklepie jako aplikację beta.
Publikacja w Connect IQ Store
Kreator nie przesyła plików do sklepu. Zaloguj się do panelu dewelopera Connect IQ (apps.garmin.com/developer), utwórz aplikację typu "watch face", prześlij plik .iq, dodaj opis i zrzuty ekranu i wyślij aplikację do weryfikacji.
Aby zaktualizować aplikację, zbuduj nowy plik .iq (jego wersja zwiększa się automatycznie) i prześlij go jako nową wersję tej samej aplikacji. UUID i klucz dewelopera muszą pozostać takie same.
API
Przegląd
Interfejs API PayToUse realizuje następujące funkcje:
- Sprawdza status aktywacji kodu odblokowującego i w razie potrzeby go aktywuje.
- Pobiera dane dotyczące poziomu glukozy we krwi z aplikacji NightScout.
- Pobiera aktualne dane pogodowe dla wskazanej lokalizacji.
Wszystkie informacje można uzyskać i zwrócić w ramach jednego żądania.
Punkty końcowe API
Możesz skorzystać z jednego z poniższych punktów końcowych:
- https://api.pay-to-use.com
- https://api.p2u.io
Oba punkty końcowe obsługują żądania GET i POST.
Parametry żądania
- device: ciąg znaków (wymagane) — unikalny identyfikator urządzenia
- app: liczba całkowita (wymagane) — identyfikator Twojej aplikacji
- model: ciąg znaków (opcjonalnie) — kod modelu urządzenia, niezbędny do gromadzenia i wyświetlania statystyk dotyczących urządzeń korzystających z aplikacji
- code: ciąg znaków (opcjonalnie) — kod odblokowujący
- bg: tablica asocjacyjna (opcjonalnie) — dane służące do pobierania wyników pomiarów poziomu glukozy we krwi z aplikacji NightScout
- url: ciąg znaków (opcjonalnie) — adres aplikacji NightScout
- weather: tablica asocjacyjna (opcjonalnie) — dane potrzebne do sprawdzenia aktualnej pogody
- appid: ciąg znaków (opcjonalnie) — klucz dostępu do interfejsu API pogody
- lat: liczba zmiennoprzecinkowa (opcjonalnie) — szerokość geograficzna
- lon: liczba zmiennoprzecinkowa (opcjonalnie) — długość geograficzna
- provider: liczba całkowita (opcjonalnie) — dostawca danych pogodowych
Lista obsługiwanych dostawców danych pogodowych
1. OpenWeatherMap
- Opis: OpenWeatherMap udostępnia dane pogodowe z całego świata, w tym informacje o pogodzie w czasie rzeczywistym, dane historyczne oraz 16-dniowe prognozy. Dzięki szerokiemu zasięgowi geograficznemu i częstym aktualizacjom OpenWeatherMap jest popularnym rozwiązaniem w aplikacjach wymagających zarówno aktualnych informacji o pogodzie, jak i długoterminowych prognoz.
- Dostarczone dane: Temperatura, wilgotność, prędkość wiatru, jakość powietrza, prawdopodobieństwo opadów i inne dane w czasie rzeczywistym. Serwis udostępnia zarówno dane bieżące, jak i prognozy, w tym dane pogodowe z dokładnością co do minuty dla wybranych lokalizacji.
- Wybór dostawcy: W sekcji weather żądania podaj provider = 1, aby wybrać OpenWeatherMap jako dostawcę danych pogodowych.
- Wskazówki dotyczące użytkowania: Oferuje wersje bezpłatną i płatną, a dostęp do danych odbywa się poprzez uwierzytelnianie za pomocą klucza API. Zaawansowane warstwy danych i funkcje premium są dostępne w planach płatnych.
- One Call API 3.0: Indeks UV jest dostępny tylko z kluczem z subskrypcją One Call API 3.0 (osobna subskrypcja na koncie OpenWeatherMap). Z takim kluczem jedno zapytanie One Call zastępuje osobne zapytania o bieżącą pogodę i prognozę. Jeśli One Call odrzuci klucz, używane jest bezpłatne API 2.5, a One Call jest ponawiane po dobie.
- Dokumentacja API: Dostępne tutaj.
2. QWeather
- Opis: QWeather, znany również jako HeWeather, dostarcza obszerne dane pogodowe dotyczące przede wszystkim Chin, ale obejmuje również dane międzynarodowe. Serwis oferuje szczegółowe informacje, takie jak aktualna pogoda, prognozy, dane o jakości powietrza oraz ostrzeżenia.
- Dostarczone dane: Aktualna temperatura, wilgotność, indeks UV, poziom zanieczyszczenia, prognozy dzienne i godzinowe, a także ostrzeżenia o trudnych warunkach pogodowych. Serwis znany jest ze szczegółowych danych dotyczących jakości powietrza oraz aktualizacji w czasie rzeczywistym na temat zmieniających się warunków pogodowych.
- Wybór dostawcy: W sekcji weather żądania podaj provider = 2, aby wybrać QWeather jako dostawcę danych pogodowych.
- Wskazówki dotyczące użytkowania: QWeather oferuje dostęp do interfejsu API w ramach planu bezpłatnego i premium. Plan bezpłatny zapewnia ograniczony dostęp do danych, natomiast opcje premium obejmują dodatkowe punkty danych i lokalizacje.
- Dokumentacja API: Dostępne tutaj.
3. MET Weather (MET Norway)
- Opis: Interfejs API MET Weather, udostępniany przez MET Norway, zapewnia dostęp do szerokiego zakresu otwartych danych meteorologicznych, w tym prognoz, danych historycznych oraz danych dotyczących Norwegii i krajów skandynawskich. Dzięki swojej dokładności i przejrzystości MET Weather doskonale nadaje się do zastosowań wymagających wysoce wiarygodnych danych pogodowych.
- Dostarczone dane: Aktualne warunki pogodowe, prognozy, opady, temperatura, dane dotyczące wiatru oraz indeks UV. Serwis MET Weather oferuje specjalistyczne dane dotyczące regionów skandynawskich, ale udostępnia również informacje pogodowe z całego świata.
- Wybór dostawcy: W sekcji weather żądania podaj provider = 3, aby wybrać MET Weather jako dostawcę danych pogodowych.
- Wskazówki dotyczące użytkowania: Wszystkie dane udostępniane przez MET Weather są dostępne do swobodnego wykorzystania na licencji Creative Commons, która zezwala zarówno na zastosowania niekomercyjne, jak i komercyjne bez żadnych opłat. MET Norway cieszy się renomą dzięki swoim danym środowiskowym, co czyni tę organizację zaufanym dostawcą, zwłaszcza w Europie.
- Dokumentacja API: Dostępne tutaj.
Przykładowe zapytanie
function onTemporalEvent() as Void {
var ds = System.getDeviceSettings();
if (!ds.phoneConnected) { // Sprawdza, czy urządzenie jest podłączone do telefonu w celu wysłania żądania
return;
}
var id = ds.uniqueIdentifier;
if (id == null) { // Sprawdza, czy urządzeniu przypisano unikalny identyfikator
return;
}
var request = {};
var lockCheck = Application.Storage.getValue("LastCodeCheckTimestamp");
if (lockCheck == null || lockCheck <= Time.now().value()) { // W razie potrzeby wysyła kod
request.put("code", Application.Properties.getValue("UnlockCode"));
}
var ns_url = Application.Properties.getValue("NS");
if (!ns_url.equals("")) { // W razie potrzeby wysyła adres URL aplikacji NightScout
request.put("bg", { "url" => ns_url });
}
var wP = Application.Properties.getValue("Weather");
if (wP != 0) { // W razie potrzeby wysyła parametry zapytania o pogodę
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()) {
// Wypełnia wymagane parametry żądania
request.put("device", id);
request.put("app", p2uAppID); // identyfikator Twojej aplikacji
request.put("model", ds.partNumber);
Toybox.Communications.makeWebRequest(
"https://api.p2u.io", // Punkt końcowy 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)
);
}
}
Odpowiedź API
Interfejs API zwraca obiekt JSON zawierający informacje o statusie odblokowania, poziomie glukozy oraz pogodzie.
Parametry odpowiedzi
Wyniki weryfikacji kodu odblokowującego (jeśli wysłano żądanie):
- response: liczba całkowita — kod zwrotny
- msg: ciąg znaków — komunikat dotyczący wyniku weryfikacji
- code: ciąg znaków — kod odblokowujący, którego dotyczy wynik, jeśli jest znany
- expires: liczba całkowita — znacznik czasu wygaśnięcia kodu w formacie UNIXTIMESTAMP
- qr: array — Kod QR do realizacji zakupu lub weryfikacji numeru seryjnego, jeśli dotyczy
Odpowiedź aplikacji NightScout (jeśli wysłano żądanie):
- bg: tablica asocjacyjna — sformatowana odpowiedź z aplikacji NightScout
- value: liczba całkowita — poziom glukozy we krwi w mg/dl
- date: liczba całkowita — znacznik czasu wygaśnięcia kodu w formacie UNIXTIMESTAMP
- direction: ciąg znaków — tendencja zmian poziomu glukozy we krwi
Odpowiedź interfejsu API pogody (jeśli wysłano żądanie):
- weather: tablica asocjacyjna — sformatowana odpowiedź z interfejsu API pogody
- provider: liczba całkowita — identyfikator dostawcy danych pogodowych
- weather: array — aktualne warunki pogodowe. Może zwrócić jedną lub dwie wartości; jeśli zwrócone zostaną dwie wartości, odpowiadają one warunkom panującym w ciągu dnia i w nocy
- temp: liczba zmiennoprzecinkowa — aktualna temperatura w stopniach Celsjusza
- feels_like: liczba zmiennoprzecinkowa — temperatura odczuwalna w stopniach Celsjusza
- pressure: liczba całkowita — ciśnienie atmosferyczne w hPa
- humidity: liczba całkowita — wilgotność w %
- precipitation: liczba całkowita — prawdopodobieństwo opadów w %
W MET Weather tylko w krajach nordyckich. -1, jeśli wartość jest niedostępna. - wind: liczba całkowita — kierunek wiatru w stopniach
- wind_speed: liczba zmiennoprzecinkowa — prędkość wiatru w m/s
- wind_gust: liczba zmiennoprzecinkowa — prędkość porywów wiatru w m/s
Niedostępne dla QWeather. W MET Weather tylko w krajach nordyckich. -1, jeśli wartość jest niedostępna. - uvi: liczba zmiennoprzecinkowa — indeks UV
W OpenWeatherMap tylko z kluczem z subskrypcją One Call API 3.0. W QWeather maksimum dzienne. W MET Weather indeks UV przy bezchmurnym niebie. -1, jeśli wartość jest niedostępna. - temp_low: liczba zmiennoprzecinkowa — dzisiejsza minimalna temperatura w stopniach Celsjusza
- temp_high: liczba zmiennoprzecinkowa — dzisiejsza maksymalna temperatura w stopniach Celsjusza
- sunrise_today: liczba całkowita — dzisiejsza godzina wschodu słońca w formacie UNIXTIMESTAMP
- sunset_today: liczba całkowita — dzisiejsza godzina zachodu słońca w formacie UNIXTIMESTAMP
- sunrise_tomorrow: liczba całkowita — czas jutrzejszego wschodu słońca w formacie UNIXTIMESTAMP
- sunset_tomorrow: liczba całkowita — czas jutrzejszego zachodu słońca w formacie UNIXTIMESTAMP
- aqi: tablica asocjacyjna — wskaźnik jakości powietrza
- level: liczba całkowita — poziom wskaźnika jakości powietrza
- value: liczba całkowita — wartość wskaźnika jakości powietrza
Przykładowa odpowiedź
{
"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
}
}
}
Kody odpowiedzi
Pole response wyniku weryfikacji kodu odblokowującego przyjmuje jedną z następujących wartości. Przykłady odpowiedzi i kolejność sprawdzeń opisano w sekcji Sprawdzenia po stronie API.
| Kod | Opis |
|---|---|
| 101 | Kod jest prawidłowy. Aplikację można odblokować. |
| 102 | Brak prawidłowego kodu, ale okres próbny jeszcze się nie skończył. Aplikację można odblokować do daty z pola expires. |
| 103 | Brak prawidłowego kodu, ale urządzenie jest beta testerem: jego pierwsze wywołanie API nastąpiło przed datą z pola Data wydania aplikacji. Aplikację można odblokować do daty z pola expires (0 - bez ograniczeń). |
| 201 | Kod nie został znaleziony lub został usunięty. |
| 202 | Kod jest już aktywowany na innym urządzeniu. |
| 203 | Kod wygasł. |
| 204 | Okres próbny się skończył, a nie przesłano prawidłowego kodu. |
| 301 | Aplikacja nie została znaleziona lub jest niedostępna. |
| 302 | Okres ważności kodu nie jest określony. |
| 303 | Za mało parametrów w żądaniu. |
| 304 | Dla tej aplikacji wymagany jest identyfikator urządzenia. |
| 401 | Błąd zapisu kodu. Napisz do pomocy technicznej na adres [email protected]. |
| 402 | Błąd zapisu urządzenia. Napisz do pomocy technicznej na adres [email protected]. |
| 500 | Nieznany błąd. Napisz do pomocy technicznej na adres [email protected]. |
Kody 1xx oznaczają, że aplikację można odblokować, 2xx - że musi pozostać zablokowana, 3xx - błąd w żądaniu, 4xx i 5xx - błąd po stronie PayToUse. W przypadku błędów 4xx i 5xx zaleca się zachowanie ostatniego pomyślnego wyniku i ponowienie żądania później.
Jeśli w ustawieniach aplikacji włączona jest opcja Zezwalaj na ponowne wysłanie kodu według identyfikatora urządzenia, żądanie zawiera identyfikator urządzenia, ale nie zawiera kodu, a do tego urządzenia jest już przypisany prawidłowy kod, API zwraca 101 razem z tym kodem w polu code. Aplikacja może go zapisać i nie prosić już użytkownika o jego wprowadzenie.
Notatki
- Żądania wysyłane za pomocą bg wymagają połączenia z aplikacją NightScout.
- W przypadku każdego żądania zawierającego code API automatycznie sprawdza status kodu i aktywuje go, jeśli jest nieaktywny.
- Należy pamiętać, że parametry API mogą z czasem ulegać aktualizacji lub modyfikacji w celu poprawy funkcjonalności, kompatybilności i bezpieczeństwa. Zaleca się okresowe sprawdzanie dokumentacji API pod kątem wszelkich zmian, które mogą mieć wpływ na integrację lub korzystanie z interfejsu.
Dostawcy pogody
Poniżej znajduje się zestawienie warunków pogodowych zwracanych w polu weather z wartościami poszczególnych dostawców.
Garmin
Szczegółowy opis funkcji pogodowych i stałych biblioteki Garmin SDK można znaleźć pod tym linkiem. W zależności od wybranego dostawcy danych pogodowych można zapisywać wartości uzyskane z interfejsu API lub wyniki funkcji pogodowych biblioteki Garmin SDK, aby zapewnić spójność wyświetlania wartości na ekranie.
| ID | Opis | Dzień | Noc |
|---|---|---|---|
| 0 | Bezchmurne niebo |
0x53 |
0x54 |
| 40 | Ładna pogoda | ||
| 23 | Przeważnie bezchmurnie |
0x55 |
0x56 |
| 1 | Częściowe zachmurzenie |
0x57 |
0x58 |
| 22 | Częściowo bezchmurnie | ||
| 2 | Przeważnie pochmurno |
0x59 |
|
| 52 | Cienkie chmury | ||
| 20 | Pochmurno |
0x5A |
|
| 45 | Pochmurno, możliwe opady deszczu | ||
| 31 | Mżawka |
0x3E |
|
| 14 | Słaby deszcz |
0x42 |
|
| 24 | Słabe przelotne opady | ||
| 3 | Deszcz |
0x43 |
|
| 25 | Przelotne opady | ||
| 27 | Możliwe przelotne opady deszczu |
0x46 |
|
| 11 | Miejscami przelotne opady | ||
| 15 | Ulewny deszcz | ||
| 26 | Silne przelotne opady | ||
| 28 | Możliwość wystąpienia burz |
0x36 |
0x37 |
| 12 | Przelotne burze z piorunami |
0x38 |
|
| 6 | Burze z piorunami |
0x39 |
|
| 8 | Mgła |
0x4E |
|
| 9 | Zamglenie | ||
| 29 | Lekka mgła | ||
| 39 | Mgiełka | ||
| 30 | Pył |
0x4F |
|
| 35 | Piasek | ||
| 33 | Dym | ||
| 38 | Popiół wulkaniczny | ||
| 37 | Burza piaskowa | ||
| 13 | Opady | ||
| 5 | Wietrznie |
0x52 |
|
| 36 | Szkwał | ||
| 48 | Przelotny śnieg | ||
| 32 | Tornado |
0x50 |
|
| 41 | Huragan | ||
| 42 | Burza tropikalna | ||
| 50 | Ziarna lodowe |
0x45 |
|
| 7 | Mieszane opady zimowe | ||
| 18 | Lekki deszcz ze śniegiem | ||
| 19 | Ulewny deszcz ze śniegiem | ||
| 21 | Deszcz ze śniegiem | ||
| 49 | Marznący deszcz | ||
| 44 | Prawdopodobieństwo opadów deszczu lub śniegu | ||
| 47 | Pochmurno, możliwe opady deszczu lub śniegu | ||
| 34 | Lód | ||
| 51 | Lód i śnieg | ||
| 43 | Możliwość opadów śniegu |
0x4C |
0x4D |
| 16 | Niewielkie opady śniegu | ||
| 46 | Pochmurno, możliwe opady śniegu |
0x4A |
|
| 4 | Śnieg | ||
| 17 | Obfite opady śniegu |
0x4B |
|
| 10 | Grad |
0x3A |
|
Open Weather Map
Zobacz przykładowy zestaw ikon dla OpenWeatherMap tutaj.
| ID | Opis | Dzień | Noc |
|---|---|---|---|
| 2xx | Burza | ||
| 200 | Burza z niewielkim deszczem |
0x36 |
0x37 |
| 201 | Burza z deszczem |
0x38 |
|
| 202 | Burza z ulewnym deszczem | ||
| 210 | Lekka burza | ||
| 211 | Burza |
0x39 |
|
| 212 | Silna burza |
0x3B |
|
| 221 | Nieregularna burza | ||
| 230 | Burza z lekką mżawką |
0x3A |
|
| 231 | Burza z mżawką | ||
| 232 | Burza z silną mżawką | ||
| 3xx | Mżawka | ||
| 300 | Lekka mżawka |
0x3C |
0x3D |
| 301 | Mżawka |
0x3E |
|
| 302 | Silna mżawka |
0x3F |
|
| 310 | Lekka mżawka z deszczem |
0x40 |
|
| 311 | Mżawka z deszczem | ||
| 312 | Silna mżawka z deszczem |
0x41 |
|
| 313 | Przelotny deszcz i mżawka | ||
| 314 | Silny przelotny deszcz i mżawka | ||
| 321 | Przelotna mżawka | ||
| 5xx | Deszcz | ||
| 500 | Słaby deszcz |
0x42 |
|
| 501 | Umiarkowany deszcz |
0x43 |
|
| 502 | Intensywny deszcz |
0x44 |
|
| 503 | Bardzo intensywny deszcz | ||
| 504 | Ekstremalny deszcz | ||
| 511 | Marznący deszcz |
0x45 |
|
| 520 | Lekki przelotny deszcz |
0x46 |
|
| 521 | Przelotny deszcz | ||
| 522 | Intensywny przelotny deszcz | ||
| 531 | Nieregularny przelotny deszcz | ||
| 6xx | Śnieg | ||
| 600 | Niewielkie opady śniegu |
0x4C |
0x4D |
| 601 | Śnieg |
0x4A |
|
| 602 | Obfite opady śniegu | ||
| 611 | Ziarna lodowe |
0x45 |
|
| 612 | Lekki przelotny deszcz ze śniegiem | ||
| 613 | Przelotny deszcz ze śniegiem | ||
| 615 | Lekki deszcz i śnieg | ||
| 616 | Deszcz i śnieg | ||
| 620 | Lekki przelotny śnieg |
0x4B |
|
| 621 | Przelotny śnieg | ||
| 622 | Intensywny przelotny śnieg | ||
| 7xx | Atmosfera | ||
| 701 | Lekka mgła |
0x4E |
|
| 711 | Dym |
0x4F |
|
| 721 | Mgiełka | ||
| 731 | Wiry piasku/pyłu | ||
| 741 | Mgła | ||
| 751 | Piasek |
0x4F |
|
| 761 | Pył | ||
| 762 | Popiół wulkaniczny | ||
| 771 | Szkwały |
0x52 |
|
| 781 | Tornado |
0x50 |
|
| 800 | Bezchmurne niebo | ||
| 800 | Bezchmurne niebo |
0x53 |
0x54 |
| 80x | Chmury | ||
| 801 | Małe zachmurzenie 11–25% |
0x55 |
0x56 |
| 802 | Umiarkowane zachmurzenie 25–50% |
0x57 |
0x58 |
| 803 | Duże zachmurzenie 51–84% |
0x59 |
|
| 804 | Całkowite zachmurzenie 85–100% |
0x5A |
|
QWeather
Aby obejrzeć oryginalny zestaw ikon pogodowych, kliknij tutaj
| ID | Opis | Dzień | Noc |
|---|---|---|---|
| 302 | Burza z przelotnym deszczem |
0x36 |
0x37 |
| 303 | Silna burza z piorunami |
0x38 |
|
| 310 | Ulewa |
0x39 |
|
| 317 | Od ulewy do silnej ulewy | ||
| 304 | Grad |
0x3A |
|
| 311 | Silna ulewa |
0x3B |
|
| 312 | Bardzo silna ulewa | ||
| 318 | Ulewa o intensywności od silnej do bardzo silnej | ||
| 309 | Mżawka |
0x3C |
0x3D |
| 404 | Ziarna lodowe |
0x3E |
|
| 305 | Lekki deszcz |
0x42 |
|
| 314 | Lekki lub umiarkowany deszcz | ||
| 306 | Umiarkowane opady deszczu |
0x43 |
|
| 315 | Umiarkowane lub intensywne opady deszczu | ||
| 399 | Deszcz | ||
| 308 | Ekstremalny deszcz |
0x44 |
|
| 316 | Od intensywnego deszczu do ulewy | ||
| 313 | Marznący deszcz |
0x45 |
|
| 405 | Deszcz i śnieg | ||
| 300 | Przelotny deszcz |
0x46 |
|
| 301 | Intensywny przelotny deszcz | ||
| 307 | Intensywny deszcz | ||
| 350 | Przelotny deszcz | ||
| 351 | Intensywny przelotny deszcz | ||
| 400 | Lekki śnieg |
0x4C |
0x4D |
| 408 | Słabe lub umiarkowane opady śniegu | ||
| 499 | Śnieg | ||
| 401 | Umiarkowane opady śniegu |
0x4A |
|
| 402 | Intensywne opady śniegu | ||
| 409 | Umiarkowane lub intensywne opady śniegu | ||
| 410 | Od obfitych opadów śniegu do burzy śnieżnej | ||
| 403 | Burza śnieżna |
0x4B |
|
| 406 | Przelotny deszcz ze śniegiem | ||
| 407 | Przelotne opady śniegu | ||
| 456 | Przelotny deszcz ze śniegiem | ||
| 457 | Przelotne opady śniegu | ||
| 503 | Piasek |
0x4E |
|
| 504 | Pył | ||
| 507 | Burza pyłowa | ||
| 508 | Burza piaskowa | ||
| 511 | Umiarkowane zamglenie | ||
| 512 | Silne zamglenie | ||
| 513 | Bardzo silne zamglenie | ||
| 500 | Lekka mgła |
0x4F |
|
| 501 | Mgła | ||
| 502 | Mgiełka | ||
| 509 | Gęsta mgła | ||
| 510 | Silna mgła | ||
| 514 | Bardzo gęsta mgła | ||
| 515 | Wyjątkowo gęsta mgła | ||
| 100 | Słonecznie |
0x53 |
0x54 |
| 150 | Bezchmurne niebo | ||
| 101 | Pochmurno |
0x55 |
0x56 |
| 151 | Pochmurno | ||
| 102 | Małe zachmurzenie |
0x57 |
0x58 |
| 152 | Małe zachmurzenie | ||
| 103 | Częściowe zachmurzenie |
0x59 |
|
| 153 | Częściowe zachmurzenie | ||
| 104 | Pochmurno |
0x5A |
|
MET Weather
Zobacz przykładowy zestaw ikon dla MET Weather tutaj.
| ID | Opis | Dzień | Noc |
|---|---|---|---|
| lightrainshowers | Lekkie przelotne opady deszczu |
0x36 |
0x37 |
| lightrainshowersandthunder | Lekkie przelotne opady deszczu z burzą | ||
| rainshowersandthunder | Przelotne opady deszczu z burzą | ||
| heavyrainshowersandthunder | Intensywne przelotne opady deszczu z burzą | ||
| heavyrainandthunder | Intensywny deszcz z burzą |
0x38 |
|
| rainandthunder | Deszcz z burzą | ||
| lightrainandthunder | Lekki deszcz z burzą |
0x39 |
|
| heavysleetandthunder | Intensywny deszcz ze śniegiem z burzą |
0x3B |
|
| lightsleetandthunder | Lekki deszcz ze śniegiem z burzą |
0x3A |
|
| lightssleetshowersandthunder | Lekkie przelotne opady deszczu ze śniegiem z burzą | ||
| sleetandthunder | Deszcz ze śniegiem z burzą | ||
| lightsleetshowers | Lekkie przelotne opady deszczu ze śniegiem |
0x3C |
0x3D |
| sleetshowers | Przelotne opady deszczu ze śniegiem | ||
| sleetshowersandthunder | Przelotne opady deszczu ze śniegiem z burzą | ||
| heavysleetshowers | Intensywne przelotne opady deszczu ze śniegiem | ||
| heavysleetshowersandthunder | Intensywne przelotne opady deszczu ze śniegiem z burzą | ||
| lightsleet | Lekki deszcz ze śniegiem |
0x3E |
|
| sleet | Ziarna lodowe |
0x3F |
|
| heavysleet | Intensywny deszcz ze śniegiem |
0x45 |
|
| lightrain | Słaby deszcz |
0x42 |
|
| rain | Deszcz |
0x43 |
|
| heavyrain | Ulewny deszcz |
0x44 |
|
| rainshowers | Przelotne opady deszczu |
0x46 |
|
| heavyrainshowers | Intensywne przelotne opady deszczu | ||
| heavysnow | Obfite opady śniegu |
0x4B |
|
| heavysnowandthunder | Intensywne opady śniegu z burzą | ||
| snow | Śnieg | ||
| snowandthunder | Śnieg z burzą | ||
| lightsnowshowers | Lekkie przelotne opady śniegu |
0x4C |
0x4D |
| lightssnowshowersandthunder | Lekkie przelotne opady śniegu z burzą | ||
| snowshowers | Przelotne opady śniegu | ||
| snowshowersandthunder | Przelotne opady śniegu z burzą | ||
| heavysnowshowers | Intensywne przelotne opady śniegu | ||
| heavysnowshowersandthunder | Intensywne przelotne opady śniegu z burzą | ||
| lightsnow | Niewielkie opady śniegu |
0x4A |
|
| lightsnowandthunder | Lekki śnieg z burzą | ||
| fog | Mgła |
0x4F |
|
| clearsky | Bezchmurne niebo |
0x53 |
0x54 |
| fair | Ładna pogoda |
0x55 |
0x56 |
| partlycloudy | Częściowe zachmurzenie |
0x57 |
0x58 |
| cloudy | Pochmurno |
0x59 |
|