Authentication type of APIs that are included in this API Product
Example:
"authToken"
AuthTypes
string[]
An array of strings specifying the authentication methods supported by the APIs within this Product (e.g., key, oauth2). When subscribing to a plan, a developer can choose one of these methods to generate credentials
Example:
["key", "oauth2"]
Catalogues
string[]
Catalogues in which this API Product is listed
Catalogue name
CID
string
Client ID for this API Product
Example:
"2r7p8aUnkzby17hCJk8w2XvK3K6"
Content
string
Marketing description of an API Product formated as HTML text fragment
Example:
"<p>Description goes here</p>"
DCREnabled
boolean
Defines if Dynamic Client Registration is enabled for this API Product
Example:
true
Description
string
Short description of this API Product which is displayed in the Catalogue page
Example:
"Description goes here"
DisplayName
string
Name of an API Product that is displayed in the API Product Details and Catalogue pages
Example:
"ACME Payment API"
Feature
boolean
Defines if this product should be featured on the home page of the portal
Example:
true
IsDocumentationOnly
boolean
default:false
Must be false for regular API products
Logo
string
Path to the logo image for this API Product
Example:
"/system/products/2/logo/logo.png"
Name
string
name of this API Product as it comes from the API Provider
Example:
"Payment API"
Path
string
URI fragment that is specific for this product. Path is added to the catalogue path to form URI to this product: /portal/catalogue-products/Path
Example:
"acme-payment-api"
ReferenceID
string
UID of this API Product in the API Provider
Example:
"6490fd2a1ba6a6000108864d"
Scopes
string
OAuth2.0 scopes that will be assigned to OAuth2.0 clients that use this API Product. Should be comma-separated string
Example:
"payments,clients"
SpecDetails
object[] | null
Specification details for documentation-only products
Tags
string[]
Tags assigned to this API Product
Name of a tag
Templates
string[]
OAuth2.0 templates that are assigned to this API Product
Name of an OAuth2.0 template
ProviderID
integer
The foreign key linking the Product to its Provider
Preview
string
An image for the product's card view in the developer portal catalogue. This image is shown on the main API listing page. If not provided, the portal will fall back to using the product's Logo