API di progetto opzionale
Mostra le operazioni dell'applicazione concordate quando ne hai bisogno
Esamina l'ambito di un'API per un progetto idoneo e distingui le route previste dagli endpoint già costruiti.
Considera l'API un'opzione di progetto definita
- Esamina l'opzione
Verifica la disponibilità dell'API e la relativa offerta di progetto.
- Definisci l'ambito delle route
Chiarisci quali operazioni aziendali deve esporre l'API.
- Esamina il catalogo delle route
Consulta metodo, percorso e stato pianificato o attivo di ogni route.
Aggiungi un'API quando il tuo progetto ne ha bisogno
L'API di progetto è una parte opzionale dell'offerta. Esaminane ambito e condizioni prima dell'attivazione, invece di presumere che ogni applicazione la includa.
Gli strumenti API organizzano le route proposte per area aziendale. I chiarimenti aiutano a definire cosa deve fare ogni operazione prima della sua implementazione.
Distingui le route previste dagli endpoint funzionanti
Prepara l'accesso per un altro sistema. Un progetto può aver bisogno che un'altra applicazione usi le sue operazioni aziendali. Esamina l'ambito e l'offerta dell'API opzionale invece di presumere che ogni funzione sia esposta automaticamente. Le operazioni concordate definiscono a cosa deve accedere l'integrazione.
Esamina il catalogo delle route. Il catalogo mostra metodo, percorso, descrizione e stato di ogni route. Aiuta a distinguere l'ambito proposto dagli endpoint registrati come attivi. È un riferimento pratico per seguire la preparazione dell'API.
Scegli la direzione di integrazione corretta. Usare l'API di un altro fornitore ed esporre la tua applicazione sono esigenze diverse. Le connessioni esterne coprono la prima; l'API di progetto copre l'esposizione concordata. Scegli il percorso adatto allo scambio aziendale che desideri.
Distingui un'API esposta da una connessione esterna
Un'API di progetto espone le operazioni concordate della tua applicazione. Una connessione esterna descrive come la tua applicazione usa un altro servizio; rispondono a esigenze diverse.
Usa il catalogo delle route per esaminare metodo, percorso e se un endpoint è pianificato o attivo. Questa presentazione non attiva un'API per il tuo progetto.
Valuta l'opzione API rispetto a un'esigenza concreta
Individua chi utilizzerà i dati del progetto e quali operazioni richiede l'integrazione. Questo aiuta a distinguere un ambito API opzionale da una connessione a un servizio esterno esistente.
Per un progetto idoneo, esamina le route pianificate e il loro stato di costruzione. Conferma il servizio e l'ambiente pertinenti prima di considerare un endpoint disponibile per un'integrazione.
Da un ambito opzionale a un'esposizione verificata
Verifica disponibilità e condizioni. Verifica l'opzione API nell'offerta effettiva del progetto. Decidi prima dell'attivazione se l'applicazione ha bisogno di questa esposizione.
Chiarisci le operazioni. Esamina le operazioni aziendali proposte e rispondi alle domande sul loro comportamento atteso. Segui gli stati di preparazione e costruzione.
Consulta ciò che è online. Esamina il catalogo delle route e il riferimento pubblicato per un progetto attivato. Una route pianificata non è un endpoint funzionante.
Definisci l'ambito dell'integrazione prima di aggiungere un'API
Spiega le operazioni di cui ha bisogno un altro sistema ed esamina le condizioni dell'opzione. L'API deve servire uno scambio aziendale concordato.
Domande sull'API di progetto opzionale
È un'opzione la cui disponibilità e il cui prezzo compaiono nell'offerta effettiva. Un'applicazione può funzionare senza attivarla. Questa presentazione non predispone né attiva un'API per il tuo progetto.
Descrive un'operazione prevista che non è ancora registrata come endpoint attivo. Usa lo stato del catalogo e il riferimento effettivamente pubblicato prima di avviare un'integrazione.
Le viste dell'API di progetto mostrano le aree da esporre, le domande, l'infrastruttura e gli stati di costruzione. Risolvi i prerequisiti indicati ed esamina il catalogo delle route risultante.
Usa il riferimento API relativo al progetto attivato e all'ambiente pertinente. Non ricavare un endpoint o un esempio di autenticazione solo da una route pianificata.
Descrivono un altro servizio usato dalla tua applicazione. Questa direzione di integrazione è distinta dall'esporre le operazioni della tua applicazione tramite l'API di progetto.