Documentazione API

Scopri come connetterti e integrare con la nostra API.

 

Autenticazione

Tutti gli endpoint API richiedono una chiave API inviata tramite il metodo di autenticazione Bearer.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://widget.spun.zone/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errori

La nostra API utilizza codici di stato HTTP convenzionali per indicare il successo o il fallimento di una richiesta.

{
    "errors": [
        {
            "title": "Non hai accesso all'API.",
            "status": 401
        }
    ]
}
200 Richiesta completata con successo
400 Richiesta errata - I parametri richiesti sono mancanti o non validi
401 Non autorizzato - La chiave API è mancante o non valida
404 La risorsa richiesta non è stata trovata
429 Troppe richieste - Limite di velocità superato
500 Errore interno del server - questo significa che c'è un problema da parte nostra
Tutti i risultati degli endpoint API funzionano con il fuso orario UTC a meno che non sia specificato diversamente.
Utente
Statistiche
Campagne
Notifiche della campagna
Gestori delle notifiche
Registri account