API Products

Step 1: Access the API Products Page

Step 3: Click the Create Button

• Click the “+ Create” button in the upper right corner

System Checks:

• Is the Name field filled in?
• Is the Name unique? (Is there another API Product with the same name?)
• Has a Category been selected?

Successful Creation:

• A success message is displayed
• You are redirected to the API Product editing page
• The tabs (API Specification, Files, Documentation, Visibility, and Plan) are now visible.

API Specification Configuration (Required)

Specify which API Proxy or Proxy Group to use

Select Environment

Set the API Spec source

Add Documentation (Recommended)

Create documentation pages for users

Add usage examples

Visibility and Plan Configuration (Required)

Set the visibility type (Public/Private/Authorized)

Create pricing plans

Publish (Final Step)

Publish after all configurations are complete

API Products List

Access:

Manager → Administration → Portal → API Products

View Options:

1. Grid View (Card View)

• Default view
• Each API Product is displayed as a card
• Image, name, description, and status information are visible

2. List View (List View)

• Table format view
• More details are visible
• Sorting is possible

Filtering and Searching

Current Filters:

1. Search by API Product

• Search by API Product name
• Real-time search (filters as you type)

2. Search by API Proxies

• Filters products using a specific API Proxy
• Select API Proxy from the dropdown

3. Search by API Proxy Groups

• Filters products using a specific Proxy Group
• Select Proxy Group from the dropdown

4. Search by Status

• Published: Published products
• Unpublished: Unpublished (draft) products
• All: All

Ranking

Sorting Options:

• Name (A-Z, Z-A)
• Created Date (New → Old, Old → New)
• Status (Published → Unpublished)

How to Sort:

• Click on the column headers
• Each click changes the sorting direction (ASC/DESC)

Access to the Details Page

Method 1: Click from the list

• Click on a product in the API Products list

Method 2: Edit button

• Select “Edit” from the three-dot menu

Method 3: Direct URL

• /admin/api-product/{id}/edit

Detail Page Components (Top Section:)

1.Title and Image

• API Product image (large icon on the left)
• API Product name
• API Product title/description

2. Quick Info

• Store: Whether it will be displayed in the Store on the Portal
• Automatically approve: Automatic approval status
• Try It active: Is the Try It feature active?

3. Action Buttons

• Configure: Edit general settings
• Back to List: Return to the list page
• Published/Unpublished: Publication status (toggle button)

4. Information Cards Summary information in 4 cards:

• Define your API Spec: API Spec source
• Files: Number of files
• Add Documentation: Number of documentation items
• Visibility: Visibility type

Tabs

1-API Specification (Default active tab)

• API source information
• Environment information
• API operations (endpoints) list

2. Files

• Uploaded files
• Add/remove files

3. Documentation

• Custom documentation pages
• Page addition/editing

4. Visibility and Plan

• Visibility settings
• Pricing plans
• Authorized Organizations

5. Danger Zone

• Critical operations
• API Product deletion

Step 1: Accessing the API Specification Tab

API Product detail page → API Specification 

If not yet configured: “Define your API Spec” card

If configured: API information and operations list

Step 2: Click the Configure Button

Click the “Configure” button (on the right side, on the card)

The “API Configuration” dialog opens

Step 3: Selecting the API Source Type

Step 4: Selecting the API Proxy/Group

Step 5: Environment Selection

The Environment dropdown is automatically populated

The environments where the selected API Proxy/Group is deployed are listed

An environment is selected

Only deployed environments are listed

If the API has not yet been deployed, it must first be deployed from API Manager

Portal users use the API in the environment you selected

Step 6: Selecting the API Specification Source

Two Options:

1. Get from API (Recommended)

• OpenAPI/Swagger spec is automatically retrieved from the API
• Real-time updated spec is used
• Changes made to the API are automatically reflected

When to Use:

• If your API has an OpenAPI/Swagger spec
• If you don't want to manually update the spec

2. Upload spec source

• The spec file is uploaded manually (JSON/YAML)
• A static spec is used
• Updates are done manually

When to Use:

• If there is no spec in the API
• If you want to use a custom spec
• If you want to customize the spec by editing it

How to Upload:

1. Select the “Upload spec source” option
2. Click the “+ Add Spec File” button
3. Select file:
   1. Format: JSON or YAML
   2. Maximum Size: 8 MB
   3. Supported Spec: OpenAPI 2.0, OpenAPI 3.0, Swagger
4. (Optional) If multilingual support is available, upload the Turkish spec as well

Step 7: Save/Update

• Click the “Save” or “Update” button.

Accessing the Files Tab

• API Product detail page → Files

Click the Add Button

Click the “+ Add File” button

The “Add File” dialog box opens

Filling in File Information

• File name (display name)
• Example: “Java SDK”, “Postman Collection”, “API Guide”

2. File Required

• File to upload
• Maximum Size: Varies depending on platform settings
• Supported Formats: PDF, ZIP, JSON, XML, TXT, etc.

3. Description

• File description
• What it contains
• How to use it

Save

File Download

File Editing

Deleting Files

Step 1: Accessing the Documentation Tab

API Product detail page → Documentation tab

Step 2: Click the Add Page Button

Click the “+ Add Page” button

The “Add Documentation Page” dialog opens

Step 3: Fill in the Page Information

1. Name Required

• Page name
• Appears in the portal menu
• Example: “Getting Started”, “Authentication Guide”

2. Slug Required

• Short name to be used in the URL
• Automatically generated (from name)
• Must not contain special characters
• Example: “getting-started”, “authentication-guide”

3. Content Required

• Page content
• Supported Formats:
  • Markdown: Recommended
  • HTML: For rich content

Step 5: Save

Click the “Save” button

Documentation Page Editing

Find the page in the Documentation tab

Select “Edit” from the three-dot menu

Make your changes

Click the “Save” button

Delete Documentation Page

Find the page in the Documentation tab

Select “Delete” from the three-dot menu

Click “Yes” in the confirmation dialog

Step 1: Accessing the Visibility and Plan Tab

API Product detail page → Visibility and Plan tab

Adım 2: Configure Visibility

Click the “Configure” button (on the Visibility tab)

The “Configure Visibility” dialog opens

Step 3: Selecting the Visibility Type

PUBLIC Selection:

1. Select the “PUBLIC” option
2. No other settings are required
3. Click the “Save” button

PRIVATE Selection:

1. Select the “PRIVATE” option
2. No other settings are required
3. Click the “Save” button

AUTHORIZED_ORGANIZATIONS Selection:

1. Select the “AUTHORIZED_ORGANIZATIONS” option
2. Click the “Save” button
3. The “+ Add Organization” button appears on the main page
4. Use this button to select organizations

Step 4: Adding Authorized Organizations

1. FREE PLAN

Free usage

Within certain limits

May include throttling and/or quotas

2. SUBSCRIPTION PLAN 

Fixed periodic fee (monthly/annual)

Within specified usage limits

Option to continue or discontinue service upon exceeding limits

3. METERED PLAN

Usage-based pricing

Fixed fee per API call

Pay-as-you-go model

4. TIERED PLAN

The unit price changes as usage increases

Different prices for different usage ranges

Volume discount

Step 1: Click the Add Plan Button

Visibility and Plan tab → “+ Add Plan” button

Step 2: Selecting the Plan Type

Select the plan type from the dropdown:

• Free
• Subscription
• Metered
• Tiered

Form fields will appear based on the selected plan type

Step 3: Fill in the Plan Details

For the FREE PLAN:

1. Enable Throttling (Optional)
   1. Check the checkbox
   2. Throttling Count: Enter a number (e.g., 10)
   3. Throttling Interval: Select a time interval (Per Second, Per Minute)
2. Enable Quota (Optional)
   1. Check the checkbox
   2. Quota Count: Enter a number (e.g., 1000)
   3. Quota Interval: Select a time interval (Per Hour, Per Day, Per Month)

For the SUBSCRIPTION PLAN:

1. Fee (Required)
   1. Enter the subscription fee (e.g., 50)
2. Currency (Required)
   1. Select the currency (USD, EUR, TRY)
3. Billing Period (Required)
   1. Select the billing period (Monthly, Annually)
4. Throttling (Optional)
   1. Same as Free Plan
5. Quota (Optional)
   1. Same as Free Plan
6. Continue on Exceed (Optional)
   1. Checkbox: Continue when quota is exceeded?
   2. If yes, enter Fee on Exceed

For METERED PLAN:

1. Fee (Required)
   1. Fee per call (e.g., 0.01)
2. Currency (Required)
   1. Currency
3. Billing Period (Required)
   1. Billing period

For TIERED PLAN:

1. Billing Type (Required)
   1. Volume Based or Transaction Based
2. Currency (Required)
   1. Currency
3. Billing Period (Required)
   1. Billing period
4. Tiers (Required)
   1. Add tiers using the “+ Add Tier” button
   2. For each tier:
      1. Calls From: Auto-filled
      2. Calls To: Enter the end count
      3. Fee: Unit price for this tier
5. Continue on Exceed (Optional)
   1. Continue after the last tier?
6. Fee on Exceed (Optional)
   1. Price after the last tier

Adım 4: Save Plan

Click the “Save” button

The plan is verified

The plan is saved

The plan is added to the list

Click the Publish Button

API Product details page → Top right → “Publish” button (green)

 Approve

Click the “Yes, Publish” button

Publishing

The published status is set to true.

The status badge becomes “Published” (green).

Click the Unpublish Button

API Product details page → Top right → “Unpublish” button (gray)

Confirm

Click the “Yes, Remove from Publication” button

Removal from Publication

The published status is set to false

The status badge becomes “Unpublished” (gray)

• Rich-formatted product description (sanitized using getDescription()).

• List of all plan cards (Free/Subscription/Metered/Tiered).

• Responsible unit information, if available (name, contact person, email, and external link).

• Identity verification summary (Auth type, username/password header fields, JWT parameters).

• Endpoint list in Accordions structure; parameter table, request/response contents, examples.

• Code examples (Shell, Python, JavaScript, Go, Java, C#, Node, Ruby) and copy buttons.

• Live testing with “Authorize” and “Try It” actions.

• Published portal document pages are displayed as Markdown/HTML.

• If the product is not published, a warning with a lock icon appears.

• Lists which plans each Portal App is subscribed to.

• Each subscription row summarizes the plan's throttling/quota/price information.

• Pending, rejected, or active subscription statuses are indicated with icons.

• New subscriptions can be initiated from the same area, or “Unsubscribe” can be performed if applicable.

(If Analytics is enabled in the portal settings and the user is logged in)

• The jhi-api-product-analytics component retrieves the dashboard and traffic graphs.

• The file list associated with the product is displayed in a table format; download buttons are available.

Select Enpoint

• Open the API Specification tab in the product details.

• When you select an operation (GET/POST, etc.) from the left side, the details card opens.

• You will see the “Code Examples” field at the bottom of the card.

Select the Language Tab

• The tabs are listed as Shell, Python, JavaScript, Go, Java, C#, Node, and Ruby.

• Click on the language you want to use; sample code for the selected language is automatically generated.

• The most common HTTP library recommended by Apinizer is used for each language (e.g., requests for Python, HttpClient for Java).

Review the Code

• The code snippet comes ready with the HTTP method, URL format, path parameters, query/header parameters, and sample body (if any) for that endpoint.

• Since the parameters are populated according to the examples in the OpenAPI specification, they are always consistent with the documentation.

Copy with a single click

• You can copy the example to the clipboard by clicking the copy icon in the upper right corner of the code box.

• The portal displays a brief notification when it is successfully copied to the clipboard.

Adapt it to your own environment

• Code samples provide the basic framework.

• If necessary, add your authentication credentials, modify the parameter values according to your needs, and paste them into your application.

What is the difference between API Product and API Proxy?

API Proxy: The proxy/gateway in front of the backend API, includes technical configuration, policies, routing, security settings, for developers/technical teams

API Product: The product offered on the portal, business-focused packaging, pricing, documentation, visibility, prepared for end users.

• An API Product may contain one or more API Proxies.
• An API Proxy can be used in multiple API Products.

Should I create separate API Products for multiple environments?

No, it's not necessary.

Correct Approach: Create an API Product and change it by selecting Environments

How It Works:

• You select an environment in the API Product (e.g., Production)
• Users use the API in that environment
• You can create another API Product for testing (optional)

What is Try It and how do I use it?

Feature to test the API directly on the portal

Swagger UI-like interactive interface

Test the API without writing code