Portale per sviluppatori

Introduzione

L’obiettivo di Esendex è rendere accessibili le proprie API e semplificare l’invio e la ricezione di messaggi. In questa pagina forniremo una breve introduzione alle API; per approfondire l’argomento, ti invitiamo a visitare il Portale per gli sviluppatori.

Guarda il video qui sotto per una panoramica del portale per gli sviluppatori.

Video

Cos’è un’API?

Un’API (Application Programming Interface, ovvero interfaccia di programmazione delle applicazioni) collega la tua applicazione ad altri servizi o fonti di dati. Quando effettui una chiamata API, richiedi dei dati: l’API li recupera e ti invia una risposta. Per farlo, è sufficiente utilizzare un metodo HTTP per inoltrare la richiesta.

Immagina di ordinare del cibo al ristorante: comunichi al cameriere cosa desideri, lui trasmette l’ordine allo chef e infine torna portandoti il ​​cibo. Una chiamata API funziona allo stesso modo.

Le API assolvono a due funzioni principali:

• Definizione delle regole: le API spiegano come interagire con esse, stabilendo le regole per gli sviluppatori.
• Trasferimento dati: trasferiscono i dati in modo efficiente tra la tua applicazione e il server, garantendo che tu riceva le informazioni necessarie.

Endpoint API

Un endpoint API è un URL specifico che consente di accedere a una risorsa sul server. Rappresenta il punto di comunicazione tra un client API e un server API: è qui che arrivano le richieste e da cui partono le risposte.

Ogni endpoint è composto da:

• Un URL dell’endpoint
  • URL di base (Base URL): rimane fisso, ad es. https://conversations.esendex.it
  • Percorso dell’endpoint (endpoint path): qui è possibile aggiungere parametri configurabili che influenzano la risposta, agendo come filtri per la ricerca
• Un metodo HTTP
• Intestazioni (header)
• Un corpo del messaggio (body)

API REST

Le nostre API utilizzano una struttura REST (REpresentational State Transfer), nota anche come API RESTful. Ciò significa che operano online. Quando effettui una richiesta a un’API REST, ottieni tutti i dati disponibili tramite essa.

Scheda di riferimento rapido

Prima di iniziare, ecco alcuni termini relativi alle API che è utile conoscere:

Termine	Definizione
Chiave API	Un codice univoco composto da lettere e numeri che consente l’accesso a un’API
Endpoint	La posizione o il percorso digitale in cui un’API riceve le richieste relative alle proprie risorse
Metodo di richiesta	Utilizza i metodi HTTP (GET, POST, PUT, DELETE) per indicare all’API l’azione da eseguire
Chiamata API	Il processo mediante il quale un client (il tuo computer) invia una richiesta API a un server
Codice di stato	Un codice numerico presente nel corpo della risposta API che indica se la richiesta è andata a buon fine o meno
Server API	Autentica ed elabora le richieste API prima di fornire una risposta appropriata
Risposta API	Una risposta generata dal server API e inviata al client (il tuo computer)

Per saperne di più sulle API, visita il nostro Portale per sviluppatori.