Concetto: API REST di Adaptive Planning
L'approccio API REST di base
L'API Adaptive Planning include tre aree generali:
- Recupero e manipolazione dei metadati
- Recupero dei dati
- Creazione e aggiornamento dei dati
Un client richiama una chiamata API inviando una richiesta HTTP POST all'endpoint principale dei servizi Web di Adaptive Planning. L'endpoint include un numero di versione che indica la versione dell'API in uso. La versione corrente dell'API Adaptive Planning è la v40. Se l'istanza utilizza un'autenticazione regionale non statunitense, gli URL di autorizzazione e gli endpoint API variano in base all'area geografica. Consultare Riferimenti: URL di autenticazione internazionali.
https://api.adaptiveplanning.com/api/v40
Le versioni dell'API in genere vengono aggiornate con le nuove versioni dei prodotti Adaptive Planning, anche se non tutte le versioni dei prodotti generano una nuova versione dell'API. Il sistema supporta la versione corrente per almeno un anno dopo il rilascio della versione API successiva.
Per uno storico delle modifiche alle API, consultare Modifiche API per release.
La richiesta HTTP POST contiene dati di post in un documento XML. Questo documento XML include sezioni standard presenti in ogni chiamata al metodo API e sezioni specifiche per ogni chiamata al metodo API. Il server Adaptive Planning elabora la chiamata al metodo API e restituisce i risultati come un altro documento XML. Come la richiesta, il documento XML della risposta include sezioni uguali per ogni metodo API e sezioni specifiche per ogni metodo API.
Il recupero di tutti i dati utilizza una ricerca. Il chiamante specifica i criteri per soddisfare un numero di elementi e il server risponde con un elenco di entità di metadati o dati che corrispondono ai criteri. La creazione e l'aggiornamento dei dati utilizzano un caricamento in blocco dei dati, inoltrato anche tramite una direttiva POST.
Criteri di sicurezza
L'utente deve essere autenticato a ogni chiamata separata, il che elimina la possibilità che un intruso dirotta una sessione del servizio Web.
Tutte le richieste API sono crittografate perché devono utilizzare il protocollo Web HTTPS. Le credenziali di autenticazione dell'utente vengono trasmesse ad Adaptive Planning come parte del corpo della richiesta dei servizi Web. Ciò significa che il livello Web crittografa l'ID di accesso e la password di un utente prima che quest'ultimo lasci il computer che ha generato la richiesta dei servizi Web e li decrittografa solo quando il server di destinazione li riceve.
L'autenticazione di un utente in una richiesta API non crea una sessione permanente per tale utente; ogni chiamata al servizio Web separata deve autenticare il proprio utente separatamente.
Autorizzazioni e controllo dell'accesso ai dati
Un utente non richiede autorizzazioni speciali per accedere ai servizi Web. Tuttavia, l'utente che effettua la richiesta del servizio Web deve disporre delle autorizzazioni necessarie per eseguire l'azione richiesta. Esempio: un utente deve disporre dell'autorizzazione Import Capabilities
per chiamare il metodo del servizio Web importStandardData.
Inoltre, i metodi del servizio Web limitano l'output di ogni chiamata al set di dati visibile all'utente che effettua la richiesta. Esempio: il metodo del servizio Web exportData limita i dati restituiti ai dati trovati nei livelli di proprietà dell'utente chiamante.