ProductUpdateParameters interface
Parâmetros de Atualização de Produtos.
Propriedades
approval |
se a aprovação da subscrição é necessária. Se forem falsas, as novas subscrições serão aprovadas permitindo automaticamente aos programadores chamar as APIs do produto imediatamente após a subscrição. Se for verdade, os administradores têm de aprovar manualmente a subscrição antes de o programador poder fazer qualquer uma das APIs do produto. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso. |
description | Descrição do produto. Pode incluir etiquetas de formatação HTML. |
display |
Nome do produto. |
state | se o produto é publicado ou não. Os produtos publicados são detetáveis pelos utilizadores do portal do programador. Os produtos não publicados são visíveis apenas para os administradores. O estado predefinido do Produto não é Publicado. |
subscription |
Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto. Se for verdadeiro, o produto é referido como "protegido" e é necessária uma chave de subscrição válida para que um pedido a uma API incluído no produto seja bem-sucedido. Se for falso, o produto é referido como "aberto" e os pedidos para uma API incluída no produto podem ser feitos sem uma chave de subscrição. Se a propriedade for omitida ao criar um novo produto, assume-se que o valor é verdadeiro. |
subscriptions |
Se o número de subscrições que um utilizador pode ter para este produto ao mesmo tempo. Defina como nulo ou omitir para permitir subscrições ilimitadas por utilizador. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso. |
terms | Termos de utilização do produto. Os programadores que tentarem subscrever o produto serão apresentados e terão de aceitar estes termos antes de poderem concluir o processo de subscrição. |
Detalhes de Propriedade
approvalRequired
se a aprovação da subscrição é necessária. Se forem falsas, as novas subscrições serão aprovadas permitindo automaticamente aos programadores chamar as APIs do produto imediatamente após a subscrição. Se for verdade, os administradores têm de aprovar manualmente a subscrição antes de o programador poder fazer qualquer uma das APIs do produto. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso.
approvalRequired?: boolean
Valor de Propriedade
boolean
description
Descrição do produto. Pode incluir etiquetas de formatação HTML.
description?: string
Valor de Propriedade
string
displayName
Nome do produto.
displayName?: string
Valor de Propriedade
string
state
se o produto é publicado ou não. Os produtos publicados são detetáveis pelos utilizadores do portal do programador. Os produtos não publicados são visíveis apenas para os administradores. O estado predefinido do Produto não é Publicado.
state?: ProductState
Valor de Propriedade
subscriptionRequired
Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto. Se for verdadeiro, o produto é referido como "protegido" e é necessária uma chave de subscrição válida para que um pedido a uma API incluído no produto seja bem-sucedido. Se for falso, o produto é referido como "aberto" e os pedidos para uma API incluída no produto podem ser feitos sem uma chave de subscrição. Se a propriedade for omitida ao criar um novo produto, assume-se que o valor é verdadeiro.
subscriptionRequired?: boolean
Valor de Propriedade
boolean
subscriptionsLimit
Se o número de subscrições que um utilizador pode ter para este produto ao mesmo tempo. Defina como nulo ou omitir para permitir subscrições ilimitadas por utilizador. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso.
subscriptionsLimit?: number
Valor de Propriedade
number
terms
Termos de utilização do produto. Os programadores que tentarem subscrever o produto serão apresentados e terão de aceitar estes termos antes de poderem concluir o processo de subscrição.
terms?: string
Valor de Propriedade
string