Overview Persone Aziende Campi custom Azioni Carrelli Corsi edizioni Tags Stati trattativa Sms Esempi

Hai dei dubbi o delle domande ? Non esitare a contattarci, inviandoci una email a support@brainlead.it

API BrainLead v.3

Le API ti permettono di accedere ai dati presenti nella tua licenza, operando come se fossi all'interno del tuo pannello web.

API Url

L'url per accedere alle API è il seguente:

https://api.brainlead.it/3/

Autenticazione

Tutte le richieste che si desidera inviare alla nostra API devono contenere l'API Key necessaria per l'autenticazione.

Per fare questo bisogna inviare una HTTP Basic authentication, inserendo la vostra API Key.

Alcune librerie o client richiedono di specificare una password, in questo caso usa "x".

API Key

L'utilizzo dell'API Key è davvero semplice:

  • Ottieni la tua API Key, accedendo alla sezione "Settings" e successivamente in "Gestisci API"
  • Nella richiesta aggiungi una HTTP Basic authentication, utilizzando la tua API Key
  • Invia la richiesta alle nostre API

Se la tua API Key è KqiUXTTEbBP7HdYrcxIz6PWAoBa7NO9M, la tua richiesta sarebbe:

cUrl
curl -u "KqiUXTTEbBP7HdYrcxIz6PWAoBa7NO9M:x" https://app.brainlead.it/api/3/contacts/add.php
PHP
curl -u "KqiUXTTEbBP7HdYrcxIz6PWAoBa7NO9M:x" https://app.brainlead.it/api/3/contacts/add.php

Metodo chiamata

Le API accettano 3 metodi di chiamata: GET, POST e DELETE.

Il metodo GET serve per ottenere informazioni.

Il metodo POST serve per aggiungere o modificare una informazione esistente.

Il metodo DELETE serve per eliminare una informazione esistente.

HTTP status code

La risposta restituita dalle API è accompagnata da un HTTP status code, che indica l'esito della chiamata.
Ecco un elenco delel possibili risposte:

Richiesta completata con successo

200 OK

Richiesta fallita

400 Bad Request

Qualcosa non è corretto nei parametri utilizzati durante la chiamata. Il motivo verrà specificato nel corpo della risposta, all'interno del campo message.

API non trovata

404 Not Found

La richiesta è stata effettuata verso una API inesistente.

Errore interno

500 Internal Error

Qualcosa ha generato un errore all'interno delle nostre API e non c'è niente che tu possa fare per risolvere il problema. Saremo avvisati immediatamente dell'errore, ma se questo avviene spesso avvisateci.
Questo errore può essere causato da: errori di sistema, troppe connessioni al database o un attacco DDoS.

Limite chiamate raggiunto

505 API rate limit reached

Il numero massimo di chiamate verso le API sono 25 ogni 5 secondi. Se l'applicazione effettua chiamate alle API ad un ritmo più veloce, si otterrà una risposta vuota. È necessario ripetere manualmente la richiesta alle API in un secondo momento.

© 2010 BrainLead