GET
/
products
/
{product_id}
Get a product
curl --request GET \
  --url http://localhost:3001/portal-api/products/{product_id} \
  --header 'Authorization: <api-key>'
{
  "ID": 2,
  "APIDetails": [
    {
      "APIID": "a0ce49d559ce49d64fe608ea3728082a",
      "APIType": "authToken",
      "Description": "This API provides payment endpoints",
      "ListenPath": "/payments/",
      "Name": "Payment API",
      "OASUrl": "https://petstore.swagger.io/v2/swagger.json",
      "Status": true,
      "TargetURL": "http://httpbin.org/"
    }
  ],
  "AuthType": "authToken",
  "Catalogues": [
    "Public Catalogue"
  ],
  "CID": "2r7p8aUnkzby17hCJk8w2XvK3K6",
  "Content": "<p>Description goes here</p>",
  "DCREnabled": true,
  "Description": "Description goes here",
  "DisplayName": "ACME Payment API",
  "Feature": true,
  "IsDocumentationOnly": false,
  "Logo": "/system/products/2/logo/logo.png",
  "Name": "Payment API",
  "Path": "acme-payment-api",
  "ReferenceID": "6490fd2a1ba6a6000108864d",
  "Scopes": "payments,clients",
  "SpecDetails": [
    {}
  ],
  "Tags": [
    "payment"
  ],
  "Templates": [
    "Web application"
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
product_id
integer
required

UID of an API Product

Example:

1

Response

OK

​
ID
integer

UID of this API Product

Example:

2

​
APIDetails
object[]

APIs included in this API Product

​
AuthType
string

Authentication type of APIs that are included in this API Product

Example:

"authToken"

​
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

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