Per gli sviluppatori sono a disposizione le istruzioni per utilizzo dell’applicazione SqualoMail, e cioè la documentazione dell’interfaccia API.
Per riuscire a capire meglio le istruzioni, abbiamo definito prima alcuni concetti di base:
- Applicazione
Ogni nostro cliente può avere una o più applicazioni. Per distinguerle, ognuna di loro ha un proprio indirizzo URL.
Esempio: https://app_id.squalomail.net - app_id
Questo è il numero ID dell’applicazione. Si trova nell’interfaccia grafica utente o nell’indirizzo URL presente durante l’iscrizione nell’applicazione SqualoMail. Il formato dell’ID è un numero di quattro cifre.
Esempio: https://2221.squalomail.net.
Anche se utilizzi un dominio personalizzato esiste comunque un app_id, che non è mai lo stesso del tuo dominio personalizzato. - API utente (User API)
Qui sono presenti le funzionalità alle quali i client possono accedere direttamente. Per esempio: Il modulo di iscrizione sul tuo sito web, viene “POST-ato” dal visitatore del tuo sito e ciò gli permette di accedere direttamente al sistema di SqualoMail. @up-api - API di sistema (System API)
L’interfaccia di programmazione di un’applicazione è destinata alla comunicazione tra le tue applicazioni e quelle di SqualoMail. Quest’interfaccia non è adatta al tuo lato client ma al tuo lato server. Se venisse utilizzata sul lato client, potrebbe mettere a rischio i tuoi dati. @sist-api
La documentazione si divide in due parti: