Delen via


ProductEntityBaseParameters interface

Basisparameters voor productentiteit

Eigenschappen

approvalRequired

of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Indien waar, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.

description

Productbeschrijving. Kan HTML-opmaaktags bevatten.

state

of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd.

subscriptionRequired

Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Indien waar, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist voor een aanvraag naar een API die is opgenomen in het product om te slagen. Als dit onwaar is, wordt het product 'open' genoemd en kunnen aanvragen worden gedaan naar een API die is opgenomen in het product zonder abonnementssleutel. Als de eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat deze waar is.

subscriptionsLimit

Of het aantal abonnementen dat een gebruiker tegelijkertijd aan dit product kan hebben. Ingesteld op null of weglaten om onbeperkt per gebruikersabonnement toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.

terms

Productvoorwaarden. Ontwikkelaars die zich willen abonneren op het product, worden weergegeven en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.

Eigenschapdetails

approvalRequired

of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Indien waar, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.

approvalRequired?: boolean

Waarde van eigenschap

boolean

description

Productbeschrijving. Kan HTML-opmaaktags bevatten.

description?: string

Waarde van eigenschap

string

state

of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd.

state?: ProductState

Waarde van eigenschap

subscriptionRequired

Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Indien waar, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist voor een aanvraag naar een API die is opgenomen in het product om te slagen. Als dit onwaar is, wordt het product 'open' genoemd en kunnen aanvragen worden gedaan naar een API die is opgenomen in het product zonder abonnementssleutel. Als de eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat deze waar is.

subscriptionRequired?: boolean

Waarde van eigenschap

boolean

subscriptionsLimit

Of het aantal abonnementen dat een gebruiker tegelijkertijd aan dit product kan hebben. Ingesteld op null of weglaten om onbeperkt per gebruikersabonnement toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.

subscriptionsLimit?: number

Waarde van eigenschap

number

terms

Productvoorwaarden. Ontwikkelaars die zich willen abonneren op het product, worden weergegeven en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.

terms?: string

Waarde van eigenschap

string