Autenticazione
L'API CoinBoss è pubblica. Per chiamare qualsiasi endpoint di dati non servono né un account né una chiave API.
Nessuna chiave richiesta
Qualsiasi endpoint del catalogo si chiama con una semplice richiesta HTTPS GET. Le richieste anonime sono limitate per indirizzo IP: 1200 richieste al minuto.
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC"Chiave API facoltativa
Se più servizi condividono lo stesso indirizzo IP, o se le chiamate partono da una rete il cui indirizzo cambia, è possibile creare una chiave nel proprio account e inviarla nell'header CB-API-KEY. Una richiesta con una chiave valida viene conteggiata sulla chiave anziché sull'indirizzo IP.
- Le chiavi si creano e si revocano nella pagina delle chiavi API del proprio account. È richiesto un indirizzo email verificato.
- La chiave completa viene mostrata una sola volta, al momento della creazione. Viene archiviato soltanto un hash, quindi non è possibile mostrarla di nuovo.
- Ogni account può avere fino a cinque chiavi attive.
- Una chiave sconosciuta o revocata viene ignorata: la richiesta è servita come anonima e conteggiata sull'indirizzo IP.
Richiesta con chiave
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC" \
-H "CB-API-KEY: $COINBOSS_API_KEY"Livelli del limite di richieste
Tutti i livelli restituiscono gli stessi dati. Nell'attuale periodo gratuito il traffico anonimo e tutte le chiavi sono serviti al livello più alto.
| Livello | Richieste al minuto | |
|---|---|---|
| hobbyist | 30 | |
| startup | 80 | |
| standard | 300 | |
| professional | 1200 | attualmente valido per tutti |
Proteggere le chiavi
- Una chiave va trattata come una password. Va conservata in una variabile d'ambiente o in un archivio di segreti, non nel codice sorgente.
- Non incorporare una chiave in una pagina web, in un'estensione del browser o in un'app mobile. Tutto ciò che viene distribuito a un client può essere letto dai suoi utenti. Chiamare l'API dal proprio server, oppure in forma anonima dal browser.
- Revocare una chiave non appena si sospetta che sia stata esposta e crearne una nuova.
- CoinBoss non chiede mai le chiavi API degli exchange. I dati sono raccolti dagli endpoint pubblici degli exchange e questa API non richiede né accetta alcuna credenziale di exchange.
Chiamate dal browser
Le risposte includono Access-Control-Allow-Origin: *, quindi gli endpoint di dati possono essere chiamati da qualsiasi origine web. Gli header X-Request-Id, X-Cache e X-RateLimit-* sono esposti agli script.
Endpoint dell'account
Gli endpoint sotto /api/user e /api/auth appartengono all'esperienza del sito per gli utenti autenticati (watchlist, preferenze, gestione delle chiavi). Usano la sessione del sito, non fanno parte dell'API pubblica dei dati e non sono elencati nel catalogo.