Schema di gestione API
Ulteriori informazioni su Ben progettato Adattabile → Componibile → Interoperabilità → Gestione API
| Dove cercare? Area prodotto | Posizione |
Che aspetto ha? Schema |
|---|---|
| Piattaforma | Business | ✅ Le applicazioni client utilizzano la versione API più recente per chiamare le applicazioni client Salesforce che chiamano le API Salesforce Platform aggiornano regolarmente la versione API che utilizzano |
| Piattaforma | Standard di progettazione | ✅ Esistono protocolli chiari per la comunicazione tra componenti (ad esempio API) |
| Piattaforma | Standard di progettazione | ✅ I protocolli / API sono delineati in gruppi logici che i costruttori possono cercare e trovare |
| Piattaforma | Standard di progettazione | ✅ I protocolli/API definiscono i tipi di dati delle variabili, i nomi delle variabili, gli elementi obbligatori o facoltativi e forniscono una descrizione chiara di quando utilizzare |
| Piattaforma | Documentazione | ✅ È possibile cercare una particolare API o protocollo e identificare i componenti in cui è implementato |
| Piattaforma | Documentazione | ✅ La documentazione di ogni componente elenca chiaramente quale API / protocollo di comunicazione è stato implementato |
| Piattaforma | Organizzazione | ✅ I formati dei messaggi API e le variabili per la comunicazione interna sono definiti con tipi di metadati personalizzati |
| Piattaforma | Organizzazione | ✅ I formati dei messaggi API e le variabili per la comunicazione interna sono definiti con gli eventi piattaforma |
| Piattaforma | Organizzazione | ✅ Il codice e le personalizzazioni dichiarative fanno riferimento al tipo di metadati personalizzato appropriato (o evento piattaforma) per inviare o ricevere informazioni |
Schema di messaggistica ed evento
Ulteriori informazioni su Ben progettato Adattabile → Componibile → Interoperabilità → Messaggistica ed eventi
| Dove cercare? Area prodotto | Posizione |
Che aspetto ha? Schema |
|---|---|
| Data 360 | Organizzazione | ✅ Utilizzare le azioni dati con gli eventi piattaforma per riutilizzare gli schemi di integrazione esistenti Sfruttare gli eventi piattaforma per rendere disponibili le azioni dati per i sistemi esterni Sfruttare le integrazioni esistenti Pub Sub API e Event Relay |
| Piattaforma | Apex | ✅ Le definizioni degli eventi personalizzati sono limitate nell'ambito (nel codice non sono definiti eventi o messaggi a livello di sistema) |
| Piattaforma | Apex | ✅ I servizi di messaggistica o di evento a livello di sistema in Apex sono annotati in modo da renderli disponibili negli strumenti di flusso Salesforce |
| Piattaforma | Standard di progettazione | ✅ Esistono standard chiari per quando utilizzare gli schemi sincroni (messaggistica) e asincroni (sera) |
| Piattaforma | Standard di progettazione | ✅ Esistono standard chiari per le strutture di eventi e messaggi |
| Piattaforma | Flusso | ✅ Gli strumenti del flusso Salesforce fanno riferimento a servizi di messaggistica o eventi a livello di sistema |
| Piattaforma | Componenti Web Lightning (LWC) | ✅ Le definizioni degli eventi personalizzati sono limitate nell'ambito (nel codice non sono definiti eventi o messaggi a livello di sistema) |
| Piattaforma | Organizzazione | ✅ Modelli di messaggistica ed eventi coerenti vengono visualizzati nei flussi e nel codice |
| Piattaforma | Eventi piattaforma | ✅ Gli eventi piattaforma utilizzati per la messaggistica di sistema interna sono chiaramente etichettati |
Anti-schema di gestione API
Ulteriori informazioni su Ben progettato Adattabile → Componibile → Interoperabilità → Gestione API
| Dove cercare? Area prodotto | Posizione |
Cosa evitare? Anti-schema |
|---|---|
| Piattaforma | Business | ⚠️ Le applicazioni client utilizzano versioni API obsolete per chiamare le applicazioni client Salesforce che chiamano API Salesforce Platform devono aggiornare regolarmente la versione API che utilizzano alla versione più recente |
| Piattaforma | Standard di progettazione | ⚠️ Gli standard di progettazione non esistono o non definiscono API e casi d'uso |
| Piattaforma | Documentazione | ⚠️ La documentazione del componente non esiste |
| Piattaforma | Documentazione | ⚠️ La documentazione del componente descrive l'API implementata all'interno di un componente, ma è l'unico punto in cui appare la definizione API |
| Piattaforma | Documentazione | ⚠️ Non è possibile cercare un'API o un protocollo particolare e/o le ricerche non aiutano a identificare i componenti in cui è stata implementata un'API o un protocollo |
| Piattaforma | Organizzazione | ⚠️ Le API sono definite esclusivamente per la comunicazione tra Salesforce e i sistemi esterni |
| Piattaforma | Organizzazione | ⚠️ La comunicazione tra i componenti del sistema (codice e personalizzazioni dichiarative) è ad hoc |
Messaggistica ed eventi anti-schema
Ulteriori informazioni su Ben progettato Adattabile → Componibile → Interoperabilità → Messaggistica ed eventi
| Dove cercare? Area prodotto | Posizione |
Cosa evitare? Anti-schema |
|---|---|
| Piattaforma | Apex | ⚠️ Le strutture dei messaggi e/o degli eventi a livello di sistema sono definite nel codice |
| Piattaforma | Apex | ⚠️ Le strutture di eventi o messaggi a livello di sistema definite in Apex non sono disponibili in strumenti come il flusso |
| Piattaforma | Standard di progettazione | ⚠️ Non esistono standard di progettazione o mancano standard chiari per la sincronizzazione rispetto agli schemi asincroni e standard chiari per le strutture di messaggi o eventi |
| Piattaforma | Componenti Web Lightning (LWC) | ⚠️ Le strutture dei messaggi e/o degli eventi a livello di sistema sono definite nel codice |
| Piattaforma | Organizzazione | ⚠️ Diverse strategie per gli schemi di messaggistica ed eventing vengono visualizzate nel flusso e nel codice |
| Piattaforma | Eventi piattaforma | ⚠️ Gli eventi piattaforma utilizzati per la messaggistica di sistema interna non sono chiaramente etichettati o non esistono |