Costruisci integrazioni

Alcune delle app più preziose collegano un'app SOIS esistente a un servizio esterno. Un esempio comune: sincronizzare le fatture dall'app di contabilità SOIS a QuickBooks. Questa guida spiega come un'app di integrazione legge i dati SOIS in modo sicuro e si collega a un servizio esterno.

Le app di integrazione sono una categoria di prima classe. Leggono i dati di un'altra app tramite un contratto governato, mai direttamente dal suo database, e solo con il consenso del tenant.

Due lati di un'integrazione

Un'app di integrazione parla con due cose:

  1. Un'app SOIS (per esempio contabilità, magazzino o contatti). Leggi o scrivi i suoi dati tramite il suo contratto pubblicato.
  2. Un servizio esterno (per esempio QuickBooks). Lo chiami con le credenziali del tenant stesso.

Dichiara con cosa ti integri

Il tuo progetto dichiara le app SOIS da cui dipende. Quella dichiarazione fa due cose: dice a SOIS quali contratti la tua app può usare, e consente al tenant di vedere e approvare l'accesso quando installa la tua app.

Leggi i dati SOIS tramite il contratto

La tua app non tocca le tabelle di un'altra app. Legge tramite il contratto di quell'app, un insieme stabile di operazioni e forme di dati. Il tuo agente costruisce la tua mappatura rispetto a quelle forme. Durante lo sviluppo lavori con dati di esempio rappresentativi, così puoi costruire e visualizzare in anteprima l'intero flusso senza una connessione live.

In fase di esecuzione, l'accesso è governato:

  • Il tenant approva l'accesso tra app quando installa la tua app. Fa parte degli scope richiesti dalla tua app.
  • Il contratto applica ciò che la tua app può leggere o scrivere. L'isolamento del tenant non viene mai indebolito.

Collega il servizio esterno

Le credenziali esterne appartengono al tenant, non a te. La tua app dichiara le credenziali di cui ha bisogno (per esempio una connessione OAuth) e ogni tenant che installa fornisce le proprie. Non detieni mai le credenziali di un altro tenant.

Esempio: sincronizzare le fatture con QuickBooks

  1. Dichiara che la tua app si integra con l'app di contabilità.
  2. Chiedi al tuo agente di leggere la forma della fattura di contabilità e costruire una mappatura da una fattura SOIS a una fattura QuickBooks. Costruisci e visualizza in anteprima rispetto a fatture di esempio.
  3. Dichiara le credenziali OAuth di QuickBooks di cui la tua app ha bisogno.
  4. Quando un tenant installa la tua app, approva l'accesso alla contabilità e collega il proprio account QuickBooks.
  5. In fase di esecuzione, la tua app legge le fatture tramite il contratto di contabilità e le invia a QuickBooks con le credenziali del tenant, tipicamente su pianificazione o trigger.

Buone pratiche

  • Mappa i campi in modo esplicito e gestisci i casi in cui un servizio esterno si aspetta dati che la tua sorgente non ha.
  • Fallisci con delicatezza. Se il servizio esterno non è disponibile, riprova invece di perdere dati.
  • Richiedi solo gli scope di cui hai bisogno. I tenant approvano un accesso ristretto più velocemente e si fidano di più.

Prossimi passi