FAQ (Frequently Asked Questions)

Un piano è una raccolta di risorse API o un sottoinsieme di risorse da una o più API. Un piano può contenere una combinazione di tipi di operazione da API differenti. Un piano può avere un limite di frequenza comune per tutte le risorse o ciascuna risorsa può avere un limite di frequenza differente. I limiti di frequenza specificano il numero di richieste che un'applicazione può effettuare durante un intervallo di tempo specificato.

Utilizzare questo Developer Portal per esaminare i diversi piani disponibili e selezionare quello più adatto per le proprie esigenze. Alcuni piani dispongono di accesso limitato e per utilizzarli è necessario richiedere l'accesso. Quando la richiesta viene inoltrata, l'organizzazione riceve una notifica, l'amministratore API valuta la richiesta e l'utente potrebbe essere contattato per fornire ulteriori dettagli. Altri piani sono subito disponibili per l'utilizzo.

Il numero di richieste, per API differenti, effettuate dall'applicazione è visualizzato nella pagina dell'applicazione.

Fare clic su 'App' nel menu principale, quindi fare clic sulla propria applicazione. Nella tabella 'Sottoscrizioni al prodotto', verranno visualizzati tutti i piani a cui è stata sottoscritta l'applicazione.

Per ciascuna API contenuta in tale piano, è possibile visualizzare l'utilizzo in confronto al limite di frequenza del piano.

È possibile eseguire il test di un'API da questo Developer Portal.

Durante la visualizzazione dei dettagli di un'API, viene visualizzato un elenco delle operazioni contenute nell'API. Verranno mostrati il verbo e il percorso da utilizzare per l'operazione.

Facendo clic sull'operazione, vengono visualizzate ulteriori informazioni, i parametri che possono essere utilizzati, gli elementi restituiti, i possibili codici di ritorno ed il relativo significato.

È disponibile anche un pulsante 'Prova' nelle API REST che consente di provare l'operazione direttamente da Developer Portal.

Se l'API richiede un ID client o un segreto client per l'identificazione, è possibile specificare tali informazioni utilizzando le credenziali dell'applicazione nella parte superiore della sezione 'Prova'.

Quando si aggiunge un'applicazione, vengono forniti una chiave API ed un segreto per l'applicazione. È necessario fornire tali credenziali quando si richiama un'API che richiede di autenticare l'applicazione.

Per registrare un'applicazione, fare clic su App nel menu principale, quindi fare clic sul link 'Crea una nuova app'. Una volta forniti il nome dell'applicazione, la descrizione e così via, verranno visualizzati la chiave API ed il segreto dell'applicazione.

Prendere nota del segreto API, perché viene visualizzato una sola volta.

Il segreto API è memorizzato in formato codificato, per cui, se dimenticato, non è possibile richiamare la versione non codificata per recuperarne il valore.

È possibile reimpostarlo, in modo da aggiornare il valore memorizzato e restituire all'utente il nuovo valore.

Per eseguire tale operazione, fare clic su 'App' nel menu principale, fare clic sull'applicazione desiderata, quindi fare clic sul link 'Reimposta' nella sezione 'Segreto API'.

Il nuovo segreto verrà visualizzato nella parte superiore della pagina.