Documentazione API

Questa è la documentazione per gli endpoint API disponibili, che sono costruiti attorno all'architettura REST. Tutti gli endpoint API restituiranno una risposta JSON con i codici di risposta HTTP standard e richiedono un'Autenticazione Bearer tramite una chiave API.

 
Ottieni la tua chiave 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://rzx.bio/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errori

La nostra API utilizza i codici di stato HTTP standard 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 non valida - Parametri obbligatori mancanti o non validi
401 Non autorizzato - Chiave API mancante o non valida
404 La risorsa richiesta non è stata trovata
429 Troppe richieste - Limite di frequenza superato
500 Errore interno del server - si è verificato un problema da parte nostra
Tutti i risultati degli endpoint API funzionano con il UTC fuso orario a meno che non sia specificato diversamente.
Utente
Collegamenti
Statistiche dei link
Progetti
Pixel
Pagine Splash
QR Code
Firme Email
Dati
Gestori di notifiche
Domini personalizzati
Il mio Team
Membri del team
Membro del team
Pagamenti dell'account
Registri account