Un API, abbreviazione di Application Programming Interface, è un modo concordato per il software di comunicare con un altro sistema. Un sito Web fornisce pulsanti e pagine alle persone; Un'API fornisce al software un modo definito per chiedere informazioni e comprendere la risposta.
Un'API è il modo in cui un assistente pone al negozio una domanda sul tè e ottiene una risposta esatta invece di indovinare da una pagina.
Pensalo come un contatore di servizi con un modulo d'ordine chiaro. Il modulo dice cosa può essere richiesto e la risposta dice ciò che il negozio ha trovato.
Richieste e Risposte
Una richiesta è la domanda inviata al servizio. Può includere un identificatore di prodotto o condizioni come un tipo di tè e un limite di prezzo. Il endpoint del servizio è l'indirizzo in cui va quella richiesta. La risposta, a volte chiamata payload, è l'informazione rispedita.
Una risposta potrebbe contenere un nome di prodotto, una confezione, un prezzo corrente, uno stato delle scorte e un collegamento alla sua pagina. Non dovrebbe distinguere alcun prodotto corrispondente da un servizio non disponibile o da un fatto sconosciuto.
I due esempi pubblici a teas.co.uk
La Guida pubblica per il software descrive un'API Ask per domande e consigli e un'API per la verità del prodotto per cercare un articolo esatto. Quest'ultimo può utilizzare identificatori come un numero di codice a barre o il codice prodotto del negozio.
Questi percorsi hanno diversi lavori. Un'ampia domanda ha bisogno di un'interpretazione; Una ricerca esatta del prodotto ha bisogno della giusta identità. La Guida ai filtri e ai vincoli spiega come una richiesta dettagliata può essere verificata rispetto agli attributi del prodotto.
JSON e MARKDOWN
Il software riceve spesso JSON, un formato per valori ed elenchi denominati. Un articolo più lungo può essere disponibile anche come markdown, testo normale con semplici segni per intestazioni e link. Entrambi possono rendere le informazioni più facili da riutilizzare. Nessuno dei due è una fonte di verità separata se viene generata dallo stesso record mantenuto.
Leggere è diverso dal cambiare qualcosa
Cercare un prodotto legge le informazioni. L'aggiunta di un prodotto a un carrello cambia qualcosa. Il pagamento è un'ulteriore azione. L'esistenza di un'API non dice nulla da sola su quale di queste azioni è consentita.
Il cliente rimane responsabile del controllo del paniere e del pagamento sul sito del negozio.
Formati citabili
Per giornalisti, ricercatori, assistenti di intelligenza artificiale e creatori di contenuti. Scegli il formato che ti serve:
- Scarica il file .md Pulisci l'esportazione di markdown
- Scarica il file .json Esportazione di dati strutturati
libero di citare, citare e riutilizzare con attribuzione a Teas.co.uk.
Hai qualcosa da aggiungere? I clienti che hanno effettuato l'accesso possono inviare aggiunte al Tea Wiki, approvato dall'amministratore, il tuo nome sul sottotitolo, oltre ai punti premio.
Accedi per contribuire