Dokumentacja API WEEX: jak rozpocząć korzystanie z API WEEX do handlu

Rozpoczęcie korzystania z API WEEX wymaga dwóch rzeczy: oficjalnej dokumentacji API WEEX oraz klucza API skonfigurowanego pod kątem funkcji, z których chcesz korzystać. WEEX udostępnia zasoby API do handlu spot i kontraktami futures USDT-M. Dokumentacja obejmuje dane rynkowe, funkcje konta, operacje handlowe, REST API oraz połączenia WebSocket.

W przypadku publicznych danych rynkowych programiści mogą korzystać z obsługiwanych endpointów bez uwierzytelniania. Funkcje prywatne, w tym zarządzanie kontem i zleceniami, wymagają klucza API i uwierzytelnionych żądań.

Proces konfiguracji jest prosty: wybierz odpowiednią dokumentację API WEEX, utwórz klucz API, skonfiguruj wymagane uprawnienia, zabezpiecz dane uwierzytelniające i połącz aplikację z właściwym endpointem API.

Gdzie znaleźć oficjalną dokumentację API WEEX?

WEEX udostępnia osobną dokumentację API dotyczącą obsługiwanych produktów i interfejsów. Dokumentacja jest aktualizowana wraz ze zmianami funkcji API, a strony poszczególnych endpointów zawierają przykładowe żądania i odpowiedzi, które ułatwiają integrację. 

Dokumentacja Spot V3 obejmuje proces przygotowania, domeny API, uwierzytelnianie, dane rynkowe, funkcje konta, funkcje zleceń, połączenia WebSocket, limity zapytań i inne wymagania techniczne.

WEEX dzieli API na interfejsy publiczne i prywatne. Publiczne API umożliwia pobieranie konfiguracji i danych rynkowych bez uwierzytelniania. Prywatne API obejmuje takie funkcje jak zarządzanie zleceniami i kontem, a do korzystania z niego wymagane są uwierzytelnione żądania.

Przed rozpoczęciem integracji programiści powinni wybrać dokumentację dotyczącą planowanego produktu, ponieważ endpointy i wymagania techniczne mogą się różnić w przypadku rynku spot i kontraktów futures.

Jak utworzyć klucz API WEEX

Aby korzystać z prywatnych funkcji API WEEX, musisz najpierw utworzyć klucz API na swoim koncie WEEX. Zgodnie z aktualną dokumentacją Spot V3 podstawowy proces wygląda następująco:

1. Zaloguj się do WEEX za pośrednictwem platformy internetowej.
2. Otwórz sekcję zarządzania API i utwórz nowy klucz API.
3. Skonfiguruj uprawnienia wymagane do integracji.
4. W razie potrzeby przypisz adres IP odpowiedni do swojej konfiguracji.
5. Bezpiecznie zapisz dane uwierzytelniające API wygenerowane lub skonfigurowane podczas tego procesu.

Obecnie na każdym koncie WEEX można utworzyć maksymalnie 10 grup kluczy API. Dzięki temu użytkownicy mogą utrzymywać osobne klucze API dla różnych aplikacji lub konfiguracji handlowych, zamiast korzystać z jednego klucza do każdego połączenia.

Podczas tworzenia klucza API istotne są trzy dane uwierzytelniające: APIKey identyfikuje użytkownika API na potrzeby uwierzytelniania. SecretKey to klucz prywatny używany do generowania podpisów żądań.

Passphrase jest ustawiana przez użytkownika i wymagana w ramach uwierzytelnionego dostępu. Jeśli Passphrase zostanie utracona, WEEX informuje, że nie można jej odzyskać, a wtedy należy utworzyć nowy klucz API. Dane uwierzytelniające należy bezpiecznie przechowywać i nie udostępniać innym osobom.

Jak skonfigurować uprawnienia API WEEX

Nowo utworzony klucz API WEEX Spot ma domyślnie uprawnienie tylko do odczytu (Read Only). Umożliwia ono korzystanie z obsługiwanych funkcji odczytu danych, ale nie pozwala na wykonywanie operacji handlowych na rynku spot.

Jeśli aplikacja ma składać lub anulować zlecenia spot, należy włączyć odpowiednie uprawnienie Spot.

Właściwy zakres uprawnień zależy więc od funkcji, które ma wykonywać aplikacja. Narzędzie służące wyłącznie do monitorowania sald, przeglądania historii handlu lub analizowania informacji może pozostać w trybie tylko do odczytu. Aplikacja przeznaczona do składania zleceń spot wymaga uprawnienia do handlu Spot.

WEEX pozwala również przypisywać klucze API do adresów IP. Oficjalna dokumentacja ostrzega, że nieograniczone klucze API bez przypisanego adresu IP wiążą się z dodatkowym ryzykiem dla bezpieczeństwa i zaleca przypisanie adresu IP podczas tworzenia klucza.

W praktyce warto przyznać każdej integracji wyłącznie uprawnienia, których rzeczywiście potrzebuje, zamiast włączać dodatkowy dostęp, z którego aplikacja nie będzie korzystać.

Jak połączyć się z REST API WEEX

Gdy klucz API i uprawnienia są już skonfigurowane, możesz połączyć aplikację z REST API WEEX. WEEX udostępnia endpointy REST API do obsługi danych rynkowych, informacji o koncie i obsługiwanych operacji handlowych.

Publiczne endpointy umożliwiają pobieranie informacji rynkowych bez uwierzytelniania. Prywatne endpointy, takie jak funkcje konta i zleceń, wymagają uwierzytelniania przy użyciu danych API i muszą spełniać wymagania dotyczące podpisu określone w oficjalnej dokumentacji API WEEX.

Dobrym punktem wyjścia jest przetestowanie publicznego żądania dotyczącego danych rynkowych przed przejściem do funkcji wymagających uwierzytelnienia. Gdy połączenie działa, możesz korzystać z odpowiednich prywatnych endpointów w zakresie uprawnień włączonych dla klucza API.

Ponieważ endpointy API i wymagania techniczne mogą się zmieniać, podczas konfiguracji integracji zawsze korzystaj z najnowszej dokumentacji API WEEX.

Jak sprawdzić połączenie z API WEEX

Prostym sposobem na rozpoczęcie integracji jest sprawdzenie, czy aplikacja może poprawnie komunikować się z API WEEX, zanim dodasz bardziej złożone funkcje handlowe.

Na początek można wysyłać żądania do publicznego API, ponieważ nie wymagają one uwierzytelniania. Gdy podstawowe połączenie działa, można przetestować uwierzytelnione żądania zgodnie z uprawnieniami przypisanymi do klucza API.

Jeśli uwierzytelnione żądanie nie powiedzie się, warto sprawdzić kilka elementów konfiguracji. Należą do nich dane uwierzytelniające API, uprawnienia, podpis żądania, znacznik czasu, domena API i ograniczenia adresów IP.

WEEX wymaga, aby uwierzytelnione żądania korzystały ze standardowej metody podpisywania. Zgodnie z aktualną dokumentacją V3 znacznik czasu żądania jest podawany w milisekundach, a żądanie może zostać odrzucone, jeśli jego znacznik czasu różni się od czasu serwera API WEEX o więcej niż 30 sekund. 

Testowanie połączenia krok po kroku ułatwia ustalenie, czy problem dotyczy łączności, uwierzytelniania, uprawnień czy konkretnego żądania.

Co sprawdzić przed użyciem API WEEX do handlu?

Przed użyciem API WEEX do handlu sprawdź uprawnienia klucza API i upewnij się, że klucz ma tylko taki dostęp, jakiego wymaga aplikacja. WEEX zaleca również przypisywanie kluczy API do zaufanych adresów IP oraz bezpieczne przechowywanie klucza API, SecretKey i Passphrase.

Programiści powinni także sprawdzić aktualne limity zapytań API i prawidłowo obsługiwać błędy żądań. Przekroczenie obowiązujących limitów może spowodować odrzucenie żądań, dlatego systemy automatyczne należy projektować tak, aby działały w granicach limitów określonych w oficjalnej dokumentacji.

Przed rozpoczęciem handlu na żywo przetestuj dokładnie połączenie, uwierzytelnianie, uprawnienia i logikę składania zleceń. Najnowsze wymagania dotyczące bezpieczeństwa i limity zapytań znajdziesz w aktualnej dokumentacji API WEEX.

Podsumowanie

Rozpoczęcie korzystania z API WEEX obejmuje wybór odpowiedniej oficjalnej dokumentacji, utworzenie klucza API, skonfigurowanie jego uprawnień, zabezpieczenie danych uwierzytelniających i połączenie aplikacji z właściwym endpointem API.

Programiści mogą zacząć od publicznych żądań API, a następnie przejść do uwierzytelnionych funkcji konta lub handlu. Najnowsza dokumentacja API WEEX powinna być podstawowym źródłem informacji technicznych o aktualnych endpointach, wymaganiach uwierzytelniania, uprawnieniach i limitach zapytań.

FAQ

1. Gdzie znaleźć oficjalną dokumentację API WEEX?
WEEX udostępnia osobną dokumentację obejmującą produkty API, endpointy, uwierzytelnianie, połączenia WebSocket, parametry i przykłady odpowiedzi. Programiści powinni korzystać z najnowszej wersji, ponieważ funkcje API mogą być z czasem aktualizowane.

2. Jak utworzyć klucz API WEEX?
Zaloguj się na platformie internetowej WEEX i otwórz sekcję zarządzania API, aby utworzyć i skonfigurować klucz API. Obecnie na każdym koncie można utworzyć maksymalnie 10 grup kluczy API.

3. Jakie informacje należy zapisać po utworzeniu klucza API WEEX?
Bezpiecznie przechowuj APIKey, SecretKey i Passphrase. Utraconej Passphrase nie można odzyskać, więc w razie jej utraty trzeba utworzyć nowy klucz API.

4. Jakie uprawnienia ma nowy klucz API WEEX?
Nowy klucz API Spot ma domyślnie uprawnienie tylko do odczytu (Read Only). Aby wykonywać operacje handlowe na rynku spot, należy włączyć odpowiednie uprawnienie do handlu Spot.

5. Dlaczego moje żądanie API WEEX nie działa?
Do częstych przyczyn należą nieprawidłowe dane uwierzytelniające, niewystarczające uprawnienia, błędy podpisu, rozbieżności znaczników czasu, ograniczenia adresów IP lub limity zapytań. W zależności od zwróconego błędu sprawdź odpowiednią sekcję oficjalnej dokumentacji API WEEX.