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

URL di base

Autenticazione

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

Authorization: Bearer {api_key}

Esempio

curl --request GET \
--url 'https://seo.gtechgroup.it/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errori

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

Esempio

{
    "errors": [
        {
            "title": "Non hai accesso all'API.",
            "status": 401
        }
    ]
}

Codici di stato

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 - significa che c'è un problema dalla nostra parte

Tutti i risultati degli endpoint API funzionano con il fuso orario UTC a meno che non sia specificato diversamente.

Utente

Siti web

Audit SEO

Audit archiviati

Gestori delle notifiche

Domini personalizzati

Le mie squadre

Membri del team

Membro del team

Registri account