Come creare un catalogo delle interfacce tra sistemi?

Question

IT Interview Practice · Accepted Answer

Create un **catalogo delle interfacce** come inventario mantenuto dei contratti tra sistemi e dei rispettivi responsabili. Collega un diagramma architetturale ai dettagli necessari ai team per implementazione, risposta agli incidenti e pianificazione delle modifiche.

## Iniziare dai flussi aziendali

Percorrete un processo reale, come l'evasione degli ordini, ed elencate ogni chiamata API, evento, trasferimento di file e scambio dati pianificato. Includete i percorsi meno visibili, come esportazioni di riconciliazione e importazioni manuali di ripristino.

Per ogni interfaccia, registrate:

- Identificatore stabile, scopo aziendale, produttore, consumatori e contatti responsabili.
- Direzione, trasporto, endpoint o posizione del file e collegamento allo schema versionato.
- Titolarità dei dati, identificatori, classificazione e meccanismo di accesso, senza memorizzare credenziali.
- Tempistiche o pianificazione, volume atteso, limiti del payload e aspettative di servizio concordate.
- Regole per timeout, nuovi tentativi, duplicati, ordinamento e gestione degli errori, ove applicabili.
- Monitoraggio, escalation, politica di compatibilità e dipendenze per la dismissione.

## Voce di esempio

L'interfaccia IF-07 invia conferme di spedizione da un magazzino a una piattaforma ordini ogni 15 minuti. Il magazzino è responsabile del flusso; la piattaforma ordini dell'acquisizione. Il contratto definisce identificatore di spedizione, versione dello schema, numero di record e file di conferma. Le conferme mancanti vengono segnalate a un team di supporto identificato.

È più utile di una freccia etichettata “integrazione”: consente al team di capire se un aggiornamento di spedizione in ritardo dipende da un errore di trasporto, dati rifiutati o una pianificazione mancata.

## Mantenere affidabile il catalogo

Collegate schemi e runbook anziché duplicarne i contenuti. Aggiornate il catalogo quando cambia un'interfaccia e confrontatelo periodicamente con il traffico osservato e i job pianificati. Un inventario statico perde rapidamente le connessioni non ufficiali.

## Errore da evitare al colloquio

Un semplice elenco di endpoint non descrive un contratto. Una risposta solida include significato aziendale, titolarità e comportamento in caso di errore, scegliendo un dettaglio sufficiente a rimanere gestibile.

Iniziare dai flussi aziendali

Voce di esempio

Mantenere affidabile il catalogo

Errore da evitare al colloquio

Domande correlate