Condividi tramite

Informazioni di riferimento sul modello di dati del template di Gestione API di Azure

Questo argomento descrive l'entità e le rappresentazioni dei tipi per gli elementi comuni usati nei modelli di dati per i modelli del portale per sviluppatori in Gestione API di Azure.

Per altre informazioni sull'uso dei modelli, vedere Come personalizzare il portale per sviluppatori di Gestione API usando modelli.

Nota

Il contenuto della documentazione seguente riguarda il portale per sviluppatori deprecato. È possibile continuare a usarlo come al solito fino al ritiro nell'ottobre 2023, quando verrà rimosso da tutti i servizi di Gestione API. Il portale deprecato riceverà solo gli aggiornamenti critici della sicurezza. Per altre informazioni, vedere gli articoli seguenti:

Disponibilità

Importante

Questa funzionalità è disponibile nei livelli Premium, Standard, Basic e Developer di Gestione API.

Per la disponibilità delle funzionalità nei livelli v2 (anteprima), vedere la panoramica dei livelli v2.

Riferimento

API (Interfaccia di Programmazione delle Applicazioni)

L'entità API ha le proprietà seguenti:

Proprietà TIPO Descrizione
id corda Identificatore della risorsa. Identifica in modo univoco l'API all'interno dell'istanza corrente del servizio Gestione API. Il valore è un URL relativo valido nel formato di apis/{id} in cui {id} è un identificatore API. Questa proprietà è di sola lettura.
name corda Nome dell'API. Non deve essere vuoto. La lunghezza massima è di 100 caratteri.
description corda Descrizione dell'API. Non deve essere vuoto. Può includere tag di formattazione HTML. La lunghezza massima è di 1000 caratteri.
serviceUrl corda URL assoluto del servizio back-end che implementa questa API.
path corda URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio per formare un URL pubblico per questa API.
protocols matrice di numeri Descrive i protocolli in cui è possibile richiamare le operazioni in questa API. I valori consentiti sono 1 - http e 2 - httpso entrambi.
authenticationSettings impostazioni di autenticazione del server di autorizzazione Raccolta di impostazioni di autenticazione incluse in questa API.
subscriptionKeyParameterNames oggetto Proprietà opzionale che può essere utilizzata per specificare nomi personalizzati per i parametri di query e/o header che contengono la chiave di sottoscrizione. Quando questa proprietà è presente, deve contenere almeno una delle due proprietà seguenti.

{ "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } }

Riepilogo API

L'entità API summary ha le proprietà seguenti:

Proprietà TIPO Descrizione
id corda Identificatore della risorsa. Identifica in modo univoco l'API all'interno dell'istanza corrente del servizio Gestione API. Il valore è un URL relativo valido nel formato di apis/{id} in cui {id} è un identificatore API. Questa proprietà è di sola lettura.
name corda Nome dell'API. Non deve essere vuoto. La lunghezza massima è di 100 caratteri.
description corda Descrizione dell'API. Non deve essere vuoto. Può includere tag di formattazione HTML. La lunghezza massima è di 1000 caratteri.

Applicazione

L'entità application ha le proprietà seguenti:

Proprietà TIPO Descrizione
Id corda Identificatore univoco dell'applicazione.
Title corda Titolo dell'applicazione.
Description corda Descrizione dell'applicazione.
Url URI (Identificatore Uniforme delle Risorse) URI per l'applicazione.
Version corda Informazioni sulla versione per l'applicazione.
Requirements corda Descrizione dei requisiti per l'applicazione.
State numero Stato corrente dell'applicazione.

- 0 - Registrato

- 1 - Inviato

- 2 - Pubblicato

- 3 - Rifiutato

- 4 - Non pubblicato
RegistrationDate Data e ora Data e ora della registrazione dell'applicazione.
CategoryId numero Categoria dell'applicazione (finanza, intrattenimento e così via)
DeveloperId corda Identificatore univoco dello sviluppatore che ha inviato l'applicazione.
Attachments Raccolta di entità allegato . Eventuali allegati per l'applicazione, ad esempio screenshot o icone.
Icon Allegato Icona per l'applicazione.

Allegato

L'entità attachment ha le proprietà seguenti:

Proprietà TIPO Descrizione
UniqueId corda Identificatore univoco per l'allegato.
Url corda URL della risorsa.
Type corda Tipo di allegato.
ContentType corda Tipo di supporto dell'allegato.

Esempio di codice

Proprietà TIPO Descrizione
title corda Nome dell'operazione.
snippet corda Questa proprietà è deprecata e non deve essere utilizzata.
brush corda Modello di colorazione della sintassi del codice da usare durante la visualizzazione dell'esempio di codice. I valori consentiti sono plain, php, java, xml, objc, python, rubye csharp.
template corda Nome di questo modello di esempio di codice.
body corda Segnaposto per la parte di esempio del frammento di codice.
method corda Metodo HTTP dell'operazione.
scheme corda Protocollo da utilizzare per la richiesta di operazione.
path corda Percorso dell'operazione.
query corda Esempio di stringa di query con parametri definiti.
host corda URL del gateway del servizio Gestione API per l'API che contiene questa operazione.
headers Raccolta di entità Header. Intestazioni per questa operazione.
parameters Raccolta di entità del parametro . Parametri definiti per questa operazione.

Commento

L'entità API ha le proprietà seguenti:

Proprietà TIPO Descrizione
Id numero ID del commento.
CommentText corda Corpo del commento. Può includere HTML.
DeveloperCompany corda Nome della società dello sviluppatore.
PostedOn Data e ora Data e ora di pubblicazione del commento.

Problema

L'entità issue ha le proprietà seguenti.

Proprietà TIPO Descrizione
Id corda Identificatore univoco per il problema.
ApiID corda ID per l'API per cui è stato segnalato questo problema.
Title corda Titolo del problema.
Description corda Descrizione del problema.
SubscriptionDeveloperName corda Nome dello sviluppatore che ha segnalato il problema.
IssueState corda Stato corrente del problema. I valori possibili sono Proposed, Opened, Closed.
ReportedOn Data e ora Data e ora in cui è stato segnalato il problema.
Comments Raccolta di entità commento . Commenti su questo problema.
Attachments Raccolta di entità allegato . Eventuali allegati relativi al problema.
Services Raccolta di entità API. Le API sottoscritte dall'utente che ha archiviato il problema.

Filtraggio

L'entità filtering ha le proprietà seguenti:

Proprietà TIPO Descrizione
Pattern corda Il termine di ricerca corrente; o null se non è presente alcun termine di ricerca.
Placeholder corda Testo da visualizzare nella casella di ricerca quando non è specificato alcun termine di ricerca.

In questa sezione viene descritta la rappresentazione parameter.

Proprietà TIPO Descrizione
name corda Nome del parametro.
description corda Descrizione del parametro.
value corda Valore dell'intestazione.
typeName corda Tipo di dati del valore dell'intestazione.
options corda Opzioni.
required boolean Indica se l'intestazione è obbligatoria.
readOnly boolean Indica se l'intestazione è di sola lettura.

Richiesta HTTP

In questa sezione viene descritta la rappresentazione request.

Proprietà TIPO Descrizione
description corda Descrizione della richiesta di operazione.
headers matrice di entità intestazione. Intestazioni della richiesta.
parameters matrice di Parametro Raccolta di parametri di richiesta dell'operazione.
representations matrice di rappresentazione Raccolta di rappresentazioni delle richieste di operazione.

Risposta HTTP

In questa sezione viene descritta la rappresentazione response.

Proprietà TIPO Descrizione
statusCode numero intero positivo Codice di stato della risposta dell'operazione.
description corda Descrizione della risposta dell'operazione.
representations matrice di rappresentazione Raccolta di rappresentazioni della risposta operativa.

Operazione

L'entità operation ha le proprietà seguenti:

Proprietà TIPO Descrizione
id corda Identificatore della risorsa. Identifica in modo univoco l'operazione all'interno dell'istanza corrente del servizio Gestione API. Il valore è un URL relativo valido nel formato di apis/{aid}/operations/{id} in cui {aid} è un identificatore API e {id} è un identificatore dell'operazione. Questa proprietà è di sola lettura.
name corda Nome dell'operazione. Non deve essere vuoto. La lunghezza massima è di 100 caratteri.
description corda Descrizione dell'operazione. Non deve essere vuoto. Può includere tag di formattazione HTML. La lunghezza massima è di 1000 caratteri.
scheme corda Descrive i protocolli in cui è possibile richiamare le operazioni in questa API. I valori consentiti sono http, httpso sia http che https.
uriTemplate corda Modello di URL relativo che identifica la risorsa di destinazione per questa operazione. Può includere parametri. Esempio: customers/{cid}/orders/{oid}/?date={date}
host corda URL del gateway di Gestione API che ospita l'API.
httpMethod corda Metodo HTTP dell'operazione.
request Richiesta HTTP Entità contenente i dettagli della richiesta.
responses matrice di risposta HTTP Matrice di operazioni entità di risposta HTTP.

L'entità operation menu ha le proprietà seguenti:

Proprietà TIPO Descrizione
ApiId corda ID dell'API corrente.
CurrentOperationId corda ID dell'operazione corrente.
Action corda Tipo di menu.
MenuItems Raccolta di entità della voce di menu Operazione . Operazioni per l'API corrente.

L'entità operation menu item ha le proprietà seguenti:

Proprietà TIPO Descrizione
Id corda ID dell'operazione.
Title corda Descrizione dell'operazione.
HttpMethod corda Metodo HTTP dell'operazione.

Paginazione

L'entità paging ha le proprietà seguenti:

Proprietà TIPO Descrizione
Page numero Numero di pagina corrente.
PageSize numero Numero massimo di risultati da visualizzare in una singola pagina.
TotalItemCount numero Numero di elementi da visualizzare.
ShowAll boolean Indica se mostrare tutti i risultati in una singola pagina.
PageCount numero Numero di pagine di risultati.

Parametro

In questa sezione viene descritta la rappresentazione parameter.

Proprietà TIPO Descrizione
name corda Nome del parametro.
description corda Descrizione del parametro.
value corda Valore del parametro.
options matrice di stringhe Valori definiti per i valori dei parametri di query.
required boolean Specifica se il parametro è obbligatorio o meno.
kind numero Indica se questo parametro è un parametro path (1) o un parametro querystring (2).
typeName corda Tipo di parametro.

Prodotto

L'entità product ha le proprietà seguenti:

Proprietà TIPO Descrizione
Id corda Identificatore della risorsa. Identifica in modo univoco il prodotto all'interno dell'istanza corrente del servizio Gestione API. Il valore è un URL relativo valido nel formato di products/{pid} in cui {pid} è un identificatore di prodotto. Questa proprietà è di sola lettura.
Title corda Nome del prodotto. Non deve essere vuoto. La lunghezza massima è di 100 caratteri.
Description corda Descrizione del prodotto. Non deve essere vuoto. Può includere tag di formattazione HTML. La lunghezza massima è di 1000 caratteri.
Terms corda Condizioni per l'utilizzo del prodotto. Gli sviluppatori che provano a sottoscrivere il prodotto verranno presentati e dovranno accettare queste condizioni prima di poter completare il processo di sottoscrizione.
ProductState numero Specifica se il prodotto viene pubblicato o meno. I prodotti pubblicati sono individuabili dagli sviluppatori nel portale per sviluppatori. I prodotti non pubblicati sono visibili solo agli amministratori.

I valori consentiti per lo stato del prodotto sono:

- 0 - Not Published

- 1 - Published

- 2 - Deleted
AllowMultipleSubscriptions boolean Specifica se un utente può avere più sottoscrizioni al prodotto contemporaneamente.
MultipleSubscriptionsCount numero Numero massimo di sottoscrizioni a questo prodotto per cui un utente può avere contemporaneamente.

Fornitore

L'entità provider ha le proprietà seguenti:

Proprietà TIPO Descrizione
Properties dizionario stringhe Proprietà per questo provider di autenticazione.
AuthenticationType corda Tipo di provider. (Microsoft Entra ID, Account Facebook, Account Google, Account Microsoft, Twitter).
Caption corda Nome del fornitore visualizzato.

Rappresentazione

Il representationè descritto in questa sezione.

Proprietà TIPO Descrizione
contentType corda Specifica un tipo di contenuto registrato o personalizzato per questa rappresentazione, ad esempio application/xml.
sample corda Esempio della rappresentazione.

Abbonamento

L'entità subscription ha le proprietà seguenti:

Proprietà TIPO Descrizione
Id corda Identificatore della risorsa. Identifica in modo univoco la sottoscrizione all'interno dell'istanza corrente del servizio Gestione API. Il valore è un URL relativo valido nel formato di subscriptions/{sid} in cui {sid} è un identificatore di sottoscrizione. Questa proprietà è di sola lettura.
ProductId corda Identificatore della risorsa prodotto del prodotto sottoscritto. Il valore è un URL relativo valido nel formato di products/{pid} in cui {pid} è un identificatore di prodotto.
ProductTitle corda Nome del prodotto. Non deve essere vuoto. La lunghezza massima è di 100 caratteri.
ProductDescription corda Descrizione del prodotto. Non deve essere vuoto. Può includere tag di formattazione HTML. La lunghezza massima è di 1000 caratteri.
ProductDetailsUrl corda URL relativo ai dettagli del prodotto.
state corda Stato della sottoscrizione. Gli stati possibili sono elencati di seguito:

- 0 - suspended: la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto.

- 1 - active: la sottoscrizione è attiva.

- 2 - expired: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.

- 3 - submitted: la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata.

- 4 - rejected: la richiesta di sottoscrizione è stata negata da un amministratore.

- 5 - cancelled: la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore.
DisplayName corda Nome della sottoscrizione visualizzato.
CreatedDate data e ora Data di creazione della sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.
CanBeCancelled boolean Indica se la sottoscrizione può essere annullata dall'utente corrente.
IsAwaitingApproval boolean Indica se la sottoscrizione è in attesa di approvazione.
StartDate data e ora Data di inizio per la sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.
ExpirationDate data e ora Data di scadenza per la sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.
NotificationDate data e ora Data di notifica per la sottoscrizione, in formato ISO 8601: 2014-06-24T16:25:00Z.
primaryKey corda Chiave di sottoscrizione primaria. La lunghezza massima consentita è di 256 caratteri.
secondaryKey corda Chiave di sottoscrizione secondaria. La lunghezza massima consentita è di 256 caratteri.
CanBeRenewed boolean Indica se la sottoscrizione può essere rinnovata dall'utente corrente.
HasExpired boolean Indica se la sottoscrizione è scaduta.
IsRejected boolean Indica se la richiesta di sottoscrizione è stata negata.
CancelUrl corda URL relativo per annullare la sottoscrizione.
RenewUrl corda URL relativo per rinnovare la sottoscrizione.

Riepilogo delle sottoscrizioni

L'entità subscription summary ha le proprietà seguenti:

Proprietà TIPO Descrizione
Id corda Identificatore della risorsa. Identifica in modo univoco la sottoscrizione all'interno dell'istanza corrente del servizio Gestione API. Il valore è un URL relativo valido nel formato di subscriptions/{sid} in cui {sid} è un identificatore di sottoscrizione. Questa proprietà è di sola lettura.
DisplayName corda Nome visualizzato dell'abbonamento

Informazioni sull'account utente

L'entità user account info ha le proprietà seguenti:

Proprietà TIPO Descrizione
FirstName corda Nome di battesimo. Non deve essere vuoto. La lunghezza massima è di 100 caratteri.
LastName corda Cognome. Non deve essere vuoto. La lunghezza massima è di 100 caratteri.
Email corda Indirizzo di posta elettronica. Non deve essere vuoto e deve essere univoco rispetto all'istanza del servizio. La lunghezza massima è di 254 caratteri.
Password corda Password dell'account utente.
NameIdentifier corda Identificatore dell'account, uguale all'indirizzo di posta elettronica dell'utente.
ProviderName corda Nome del provider di autenticazione.
IsBasicAccount boolean True se l'account è stato registrato con posta elettronica e password; false se l'account è stato registrato utilizzando un provider.

Accesso degli utenti

L'entità user sign in ha le proprietà seguenti:

Proprietà TIPO Descrizione
Email corda Indirizzo di posta elettronica. Non deve essere vuoto e deve essere univoco rispetto all'istanza del servizio. La lunghezza massima è di 254 caratteri.
Password corda Password dell'account utente.
ReturnUrl corda URL della pagina in cui l'utente ha fatto clic su Accedi.
RememberMe boolean Indica se salvare le informazioni dell'utente corrente.
RegistrationEnabled boolean Indica se la registrazione è abilitata.
DelegationEnabled boolean Indica se l'accesso delegato è abilitato.
DelegationUrl corda URL di accesso delegato, se abilitato.
SsoSignUpUrl corda URL di accesso Single Sign-On per l'utente, se presente.
AuxServiceUrl corda Se l'utente corrente è un amministratore, si tratta di un collegamento all'istanza del servizio nel portale di Azure.
Providers Raccolta di entità provider I provider di autenticazione per l'utente.
UserRegistrationTerms corda Condizioni che un utente deve accettare prima di eseguire l'accesso.
UserRegistrationTermsEnabled boolean Indica se i termini sono abilitati.

Iscrizione utente

L'entità user sign up ha le proprietà seguenti:

Proprietà TIPO Descrizione
PasswordConfirm boolean Valore usato dal controllo di iscrizione .
Password corda Password dell'account utente.
PasswordVerdictLevel numero Valore usato dal controllo di iscrizione .
UserRegistrationTerms corda Condizioni che un utente deve accettare prima di eseguire l'accesso.
UserRegistrationTermsOptions numero Valore usato dal controllo di iscrizione .
ConsentAccepted boolean Valore usato dal controllo di iscrizione .
Email corda Indirizzo di posta elettronica. Non deve essere vuoto e deve essere univoco rispetto all'istanza del servizio. La lunghezza massima è di 254 caratteri.
FirstName corda Nome di battesimo. Non deve essere vuoto. La lunghezza massima è di 100 caratteri.
LastName corda Cognome. Non deve essere vuoto. La lunghezza massima è di 100 caratteri.
UserData corda Valore utilizzato dal controllo di iscrizione.
NameIdentifier corda Valore usato dal controllo di iscrizione .
ProviderName corda Nome del provider di autenticazione.

Passaggi successivi

Per altre informazioni sull'uso dei modelli, vedere Come personalizzare il portale per sviluppatori di Gestione API usando modelli.

  • Last updated on