Twórz integracje z API AlwaysCompleted

Połącz AlwaysCompleted z procesami po stronie swojego serwera, aby pobierać usługi, składać zamówienia i śledzić ich realizację. Ten przewodnik prowadzi od pierwszego żądania tylko do odczytu do kontroli istotnych przy tworzeniu zamówień. Miej pod ręką dokumentację API, w której znajdziesz pełne listy parametrów i przykładowe odpowiedzi.

Przygotuj się do połączenia

1. Utwórz konto i użyj przypisanego do niego klucza API w konfiguracji po stronie serwera.
2. Przeczytaj katalog usług i warunki usług, które zamierzasz oferować. Wymagania, dostępne opcje i limity zamówień zależą od wybranej usługi.
3. Wysyłaj żądania ze swojego backendu przez HTTPS. Nie wyłączaj standardowej weryfikacji certyfikatów TLS.
4. Przechowuj klucz API bezpiecznie na swoim serwerze. Nie umieszczaj go na publicznych stronach, w kodzie JavaScript przeglądarki, na zrzutach ekranu ani w udostępnianych przykładach kodu.

Wyślij pierwsze żądanie tylko do odczytu

Opisany w dokumentacji punkt końcowy przyjmuje żądania POST i zwraca JSON. Oficjalny przykład żądania korzysta z parametrów formularza kodowanych w formacie URL-encoded. Każde działanie zawiera Twój klucz API i nazwę działania.

POST https://alwayscompleted.com/api/v2

key=YOUR_API_KEY&action=services

Zastąp wartość przykładową tylko w konfiguracji po stronie serwera. Działanie services odczytuje katalog; nie tworzy zamówienia. Użyj odpowiedzi, aby ustalić ID usług i sprawdzić dostępne pola przed zbudowaniem formularza zamówienia.

Korzystaj z aktualnych informacji o usługach i koncie

Lista usług zawiera nazwę, typ, kategorię, stawkę, minimalną i maksymalną ilość każdej usługi oraz informacje o obsłudze uzupełnienia i anulowania. Powiąż wybrane ID usługi z jej aktualnym opisem i wymaganiami. Przy przygotowaniu zamówienia korzystaj ze zwróconych danych zamiast kopiować przykładowe ID lub ceny z dokumentacji.

Użyj action=balance, aby odczytać saldo konta i jego walutę. Kwoty podane w dokumentacji traktuj jako dane przykładowe. Twoja aplikacja powinna wyświetlać rzeczywistą odpowiedź i obsłużyć błędy przed kontynuowaniem.

Obsługuj zmiany w katalogu zapisanym w pamięci podręcznej

Podczas odświeżania katalogu w pamięci podręcznej sprawdź usunięte ID usług oraz zmiany stawek lub limitów ilości, zanim ponownie udostępnisz zapisane opcje. Jeśli wybranego ID nie ma w aktualnej odpowiedzi, wstrzymaj zamówienie do sprawdzenia zamiast wybierać usługę o podobnej nazwie. Jeśli zmieni się stawka, typ lub limit ilości, zaktualizuj formularz i ponownie zweryfikuj wybór przed wysłaniem action=add. Zapisz sprawdzone szczegóły usługi wraz z lokalnym rekordem zamówienia, aby późniejsze pytania można było odnieść do wyboru rzeczywiście zweryfikowanego przez aplikację.

Twórz zamówienia świadomie

Aby utworzyć zamówienie, wyślij action=add z wybranym ID usługi i polami wymaganymi dla danego typu usługi. Zamówienie typu Default używa link i quantity; inne typy mają inne parametry. Przed wysłaniem sprawdź odpowiednią sekcję dokumentacji.

Po pomyślnym utworzeniu zapisz zwrócone ID zamówienia wraz z własnym rekordem zamówienia. Jeśli żądanie przekroczy limit czasu lub jego odpowiedź będzie niejasna, sprawdź wynik przed ponownym wysłaniem. Powtarzanie żądania add bez sprawdzenia grozi utworzeniem niezamierzonego duplikatu. Nigdy nie używaj tworzenia zamówienia jako automatycznego testu połączenia.

Śledź zamówienia i obsługiwane dalsze żądania

Użyj action=status z order dla jednego zamówienia lub orders z ID rozdzielonymi przecinkami dla partii do 100 zamówień. Udokumentowana odpowiedź zawiera status, charge, start_count, remains i currency. Sprawdź każdy wynik: partia może zawierać błąd dotyczący pojedynczego ID.

Uzupełnienie i anulowanie to prośby podlegające dostępności i warunkom wybranej usługi. Użyj action=refill, aby poprosić o uzupełnienie, action=refill_status, aby je śledzić, oraz action=cancel, aby poprosić o anulowanie. Udokumentowane warianty zbiorcze przyjmują do 100 ID. Wysłanie prośby nie gwarantuje zatwierdzenia uzupełnienia lub anulowania.

Kontynuuj integrację

Korzystaj z pełnej dokumentacji API, aby sprawdzić dokładne parametry działań i przykłady. Jeśli tworzysz system obsługi usług dla klientów, zobacz AlwaysCompleted dla resellerów. Zapoznaj się z Regulaminem i zasadami oraz opisem każdej usługi przed przyjmowaniem zamówień od klientów.