Documentazione API

Scopri come connetterti e integrarti con la nostra API.

 

Autenticazione

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

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://mybotsy.com/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 correttamente
400 Richiesta errata: i parametri richiesti mancano 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 tariffa superato
500 Errore interno del server: significa che c'è un problema da parte nostra
Tutti i risultati dell'endpoint API funzionano con il fuso orario UTC se non diversamente specificato.
Utente
Squadre
Membri del team
Membro dei team
Registri dell'account