Documentazione API di WEEX: come iniziare con la WEEX Trading API

Per iniziare a usare l’API di WEEX servono due cose: la documentazione API ufficiale di WEEX e una API Key configurata per le funzioni che si desidera utilizzare. WEEX mette a disposizione risorse API per il trading spot e per i futures USDT-M; la documentazione tratta dati di mercato, funzioni dell’account, operazioni di trading, API REST e connessioni WebSocket.

Per i dati pubblici di mercato, gli sviluppatori possono accedere agli endpoint supportati senza autenticazione. Le funzioni private, tra cui la gestione dell’account e degli ordini, richiedono una API Key e richieste autenticate.

La configurazione è semplice: scegli la documentazione API di WEEX pertinente, crea una API Key, imposta le autorizzazioni necessarie, proteggi le credenziali e collega la tua applicazione all’endpoint API appropriato.

Dove si trova la documentazione API ufficiale di WEEX?

WEEX mantiene una documentazione API dedicata ai prodotti e alle interfacce supportati. La documentazione viene aggiornata quando cambiano le funzionalità API e le pagine dei singoli endpoint includono esempi di richieste e risposte per l’integrazione. 

Per Spot V3, la documentazione tratta la procedura di preparazione, i domini API, l’autenticazione, i dati di mercato, le funzioni dell’account, le funzioni degli ordini, le connessioni WebSocket, i limiti di frequenza e altri requisiti tecnici.

WEEX suddivide le API in interfacce pubbliche e private. Le API pubbliche consentono di recuperare dati di configurazione e di mercato senza autenticazione. Le API private comprendono funzioni come la gestione di ordini e account e richiedono richieste autenticate.

Prima di integrare l’API, gli sviluppatori dovrebbero selezionare la documentazione relativa al prodotto che intendono utilizzare, poiché gli endpoint e i requisiti tecnici possono variare tra spot e futures.

Come creare una API Key di WEEX

Per utilizzare le funzioni private dell’API di WEEX, devi prima creare una API Key tramite il tuo account WEEX. Secondo la documentazione attuale di Spot V3, la procedura di base è la seguente:

1. Accedi a WEEX tramite la piattaforma web.
2. Apri Gestione API e crea una nuova API Key.
3. Configura le autorizzazioni necessarie per la tua integrazione.
4. Associa un indirizzo IP, se opportuno per la tua configurazione.
5. Salva in modo sicuro le credenziali API generate o configurate durante la procedura.

Attualmente, ogni account WEEX può creare fino a 10 gruppi di API Key. In questo modo gli utenti possono mantenere API Key separate per applicazioni o configurazioni di trading diverse, invece di affidarsi a un’unica Key per ogni connessione.

Quando si crea una API Key, è importante conoscere tre credenziali: APIKey identifica l’utente API ai fini dell’autenticazione. SecretKey è la chiave privata utilizzata per generare le firme delle richieste.

La Passphrase viene impostata dall’utente ed è necessaria per l’accesso autenticato. Se la Passphrase viene smarrita, WEEX dichiara che non può essere recuperata e che occorre creare una nuova API Key. Queste credenziali vanno conservate in modo sicuro e non devono essere condivise con altre persone.

Come configurare le autorizzazioni dell’API di WEEX

Una nuova API Key Spot di WEEX dispone per impostazione predefinita dell’autorizzazione Read Only. Ciò consente alla Key di accedere alle funzioni di consultazione supportate, senza autorizzarla a eseguire operazioni di trading spot.

Se un’applicazione deve inserire o annullare ordini spot, è necessario abilitare la relativa autorizzazione Spot.

L’autorizzazione appropriata dipende quindi dalle operazioni che l’applicazione deve eseguire. Uno strumento utilizzato solo per monitorare i saldi, consultare lo storico delle operazioni o analizzare informazioni può rimanere Read Only. Un’applicazione progettata per eseguire ordini spot richiede l’autorizzazione al trading Spot.

WEEX consente inoltre agli utenti di associare le API Key a indirizzi IP. La documentazione ufficiale avverte che le API Key senza restrizioni e senza associazione a un IP comportano ulteriori rischi per la sicurezza e consiglia di associare un indirizzo IP al momento della creazione della Key.

È consigliabile concedere a ogni integrazione solo le autorizzazioni di cui ha effettivamente bisogno, evitando di abilitare accessi aggiuntivi che l’applicazione non utilizzerà.

Come connettersi all’API REST di WEEX

Una volta pronte la API Key e le relative autorizzazioni, puoi connettere la tua applicazione all’API REST di WEEX. WEEX fornisce endpoint API REST per dati di mercato, informazioni sull’account e operazioni di trading supportate.

Gli endpoint pubblici consentono di recuperare informazioni di mercato senza autenticazione. Gli endpoint privati, come quelli relativi alle funzioni dell’account e agli ordini, richiedono l’autenticazione tramite le credenziali API e devono rispettare i requisiti di firma indicati nella documentazione API ufficiale di WEEX.

Un buon punto di partenza è testare una richiesta pubblica per ottenere dati di mercato prima di passare alle funzioni autenticate. Una volta stabilita la connessione, puoi utilizzare gli endpoint privati appropriati in base alle autorizzazioni abilitate per la tua API Key.

Poiché gli endpoint API e i requisiti tecnici possono essere aggiornati, fai sempre riferimento alla documentazione API di WEEX più recente quando configuri la tua integrazione.

Come verificare la connessione all’API di WEEX

Un modo semplice per avviare un’integrazione è verificare che l’applicazione riesca a comunicare correttamente con l’API di WEEX prima di aggiungere funzioni di trading più complesse.

Puoi iniziare con le richieste API pubbliche, perché non richiedono autenticazione. Una volta stabilita la connessione di base, è possibile testare le richieste autenticate in base alle autorizzazioni assegnate alla API Key.

Se una richiesta autenticata non riesce, potrebbe essere necessario verificare diversi elementi della configurazione: le credenziali API, le autorizzazioni, la firma della richiesta, il timestamp, il dominio API e le restrizioni IP.

WEEX richiede che le richieste autenticate utilizzino un metodo di firma standardizzato. Nella documentazione V3 attuale, il timestamp della richiesta è espresso in millisecondi e una richiesta può essere rifiutata se il timestamp differisce di oltre 30 secondi dall’ora del server API di WEEX. 

Testare la connessione passo dopo passo facilita l’individuazione dell’origine di un problema: connettività, autenticazione, autorizzazioni o singola richiesta.

Cosa controllare prima di usare l’API di WEEX per il trading?

Prima di usare l’API di WEEX per il trading, controlla le autorizzazioni della tua API Key e assicurati che disponga solo degli accessi necessari all’applicazione. WEEX consiglia inoltre di associare le API Key a indirizzi IP attendibili e di proteggere la API Key, la SecretKey e la Passphrase.

Gli sviluppatori dovrebbero anche controllare gli attuali limiti di frequenza dell’API e gestire correttamente gli errori delle richieste. Il superamento dei limiti applicabili può causare il rifiuto delle richieste: i sistemi automatizzati dovrebbero quindi essere progettati per rispettare i limiti indicati nella documentazione ufficiale.

Prima di usare l’API per il trading live, testa attentamente la connessione, l’autenticazione, le autorizzazioni e la logica degli ordini. Per consultare i requisiti di sicurezza e i limiti di frequenza più recenti, fai riferimento alla documentazione API di WEEX aggiornata.

Conclusione

Per iniziare a usare l’API di WEEX occorre scegliere la documentazione ufficiale appropriata, creare una API Key, configurarne le autorizzazioni, proteggere le credenziali e collegare un’applicazione all’endpoint API pertinente.

Gli sviluppatori possono iniziare con le richieste API pubbliche e passare poi alle funzioni autenticate dell’account o di trading. Per consultare endpoint, requisiti di autenticazione, autorizzazioni e limiti di frequenza aggiornati, la documentazione API di WEEX più recente dovrebbe restare il riferimento tecnico principale.

FAQ

1. Dove posso trovare la documentazione API ufficiale di WEEX?
WEEX mette a disposizione una documentazione dedicata ai suoi prodotti API, agli endpoint, all’autenticazione, alle connessioni WebSocket, ai parametri e agli esempi di risposta. Gli sviluppatori dovrebbero utilizzare la versione più recente, poiché le funzionalità API possono essere aggiornate nel tempo.

2. Come si crea una API Key di WEEX?
Accedi alla piattaforma web di WEEX e apri Gestione API per creare e configurare una API Key. Attualmente, ogni account può creare fino a 10 gruppi di API Key.

3. Quali informazioni devo salvare dopo aver creato una API Key di WEEX?
Conserva in modo sicuro APIKey, SecretKey e Passphrase. Una Passphrase smarrita non può essere recuperata: in tal caso, è necessario creare una nuova API Key.

4. Quali autorizzazioni ha una nuova API Key di WEEX?
Una nuova API Key Spot è impostata per impostazione predefinita su Read Only. Per eseguire operazioni di trading spot, è necessario abilitare la relativa autorizzazione al trading Spot.

5. Perché la mia richiesta API di WEEX non funziona?
Tra le cause più comuni figurano credenziali errate, autorizzazioni insufficienti, errori di firma, differenze nel timestamp, restrizioni IP o limiti di frequenza. In base all’errore restituito dalla richiesta, consulta la sezione pertinente della documentazione API ufficiale di WEEX.