Documentazione API

Questa è la documentazione per i punti di accesso API disponibili, che sono costruiti attorno all'architettura REST. Tutti i punti di accesso 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 i punti di accesso API richiedono una chiave API inviata tramite il metodo di autenticazione Bearer.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://oonthe.link/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 non valida - Mancano parametri richiesti o non sono validi
401 Non autorizzato - La chiave API manca 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 del punto finale dell'API funzionano con il fuso orario UTC a meno che non sia diversamente specificato.
Utente
Links
Statistiche dei link
Progetti
Pixel
Splash page
QR Code
Firme
Dati
Gestori delle notifiche
Domini personalizzati
Pagamenti dell'account
Registri dell'account