ProductTagResourceContractProperties interface
Perfil de producto.
- Extends
Propiedades
| id | Identificador del producto en forma de /products/{productId} |
| name | Nombre del producto. |
Propiedades heredadas
| approval |
si se requiere la aprobación de la suscripción. Si es false, las nuevas suscripciones se aprobarán automáticamente, lo que permitirá a los desarrolladores llamar a las API del producto inmediatamente después de suscribirse. Si es true, los administradores deben aprobar manualmente la suscripción antes de que el desarrollador pueda cualquiera de las API del producto. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false. |
| description | Descripción del producto. Puede incluir etiquetas de formato HTML. |
| state | si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished. |
| subscription |
Si se requiere una suscripción de producto para acceder a las API incluidas en este producto. Si es true, el producto se conoce como "protegido" y se requiere una clave de suscripción válida para que una solicitud a una API incluida en el producto se realice correctamente. Si es false, el producto se conoce como "abierto" y se pueden realizar solicitudes a una API incluida en el producto sin una clave de suscripción. Si se omite la propiedad al crear un nuevo producto, se supone que el valor es true. |
| subscriptions |
Indica si el número de suscripciones que un usuario puede tener en este producto al mismo tiempo. Establezca en NULL o omita para permitir suscripciones ilimitadas por usuario. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false. |
| terms | Términos de uso del producto. Los desarrolladores que intentan suscribirse al producto se mostrarán y tendrán que aceptar estos términos para poder completar el proceso de suscripción. |
Detalles de las propiedades
id
Identificador del producto en forma de /products/{productId}
id?: string
Valor de propiedad
string
name
Nombre del producto.
name: string
Valor de propiedad
string
Detalles de las propiedades heredadas
approvalRequired
si se requiere la aprobación de la suscripción. Si es false, las nuevas suscripciones se aprobarán automáticamente, lo que permitirá a los desarrolladores llamar a las API del producto inmediatamente después de suscribirse. Si es true, los administradores deben aprobar manualmente la suscripción antes de que el desarrollador pueda cualquiera de las API del producto. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false.
approvalRequired?: boolean
Valor de propiedad
boolean
heredado deProductEntityBaseParameters.approvalRequired
description
Descripción del producto. Puede incluir etiquetas de formato HTML.
description?: string
Valor de propiedad
string
heredado deProductEntityBaseParameters.description
state
si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished.
state?: ProductState
Valor de propiedad
Heredado deProductEntityBaseParameters.state
subscriptionRequired
Si se requiere una suscripción de producto para acceder a las API incluidas en este producto. Si es true, el producto se conoce como "protegido" y se requiere una clave de suscripción válida para que una solicitud a una API incluida en el producto se realice correctamente. Si es false, el producto se conoce como "abierto" y se pueden realizar solicitudes a una API incluida en el producto sin una clave de suscripción. Si se omite la propiedad al crear un nuevo producto, se supone que el valor es true.
subscriptionRequired?: boolean
Valor de propiedad
boolean
se hereda deProductEntityBaseParameters.subscriptionRequired
subscriptionsLimit
Indica si el número de suscripciones que un usuario puede tener en este producto al mismo tiempo. Establezca en NULL o omita para permitir suscripciones ilimitadas por usuario. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false.
subscriptionsLimit?: number
Valor de propiedad
number
terms
Términos de uso del producto. Los desarrolladores que intentan suscribirse al producto se mostrarán y tendrán que aceptar estos términos para poder completar el proceso de suscripción.
terms?: string
Valor de propiedad
string
heredado deProductEntityBaseParameters.terms