GlossarioAPI
Un'API definisce un modo strutturato per scambiare dati o richiedere un'operazione tra sistemi. In un programma, può collegare acquisti, idoneità, punti o ordini. Il contratto, l'autenticazione, gli errori, i limiti e le rilavorazioni devono essere documentati per rendere l'integrazione utilizzabile.
Un esempio concreto
Un'API può ricevere un ordine convalidato e restituire il suo ID di elaborazione. Un ID univoco impedisce che la stessa transazione venga accreditata due volte.
Un punto da considerare
Coprire semplicemente il caso nominale non è sufficiente. Documentare l'autenticazione, i duplicati, gli errori, i tentativi e i limiti di frequenza.
Preparare un contratto utilizzabile da entrambi i team
Per ogni scambio, fornire un esempio accettato, un esempio rifiutato, i campi obbligatori e le regole di ripresa. Definire un identificatore di correlazione per tracciare una transazione tra i sistemi. Testare un'interruzione dopo l'elaborazione ma prima di ricevere la risposta: la ripresa deve recuperare il risultato senza creare un secondo credito. Pianificare inoltre il tracciamento dei rifiuti e la garanzia della compatibilità delle versioni.
Domande da porre al team
- Possiamo determinare se una transazione è stata elaborata dopo un'interruzione del servizio?
- Gli errori temporanei e i dati non validi vengono gestiti in modo diverso?
Amplia la tua rete.
White paper