The API Developer Portal manages frequently asked questions and answers from users. Administrator users enhance the portal's user experience by defining question-and-answer content in both English and Turkish. This allows API consumers to quickly access frequently asked information through the portal.

The Frequently Asked Questions list is structured to help users better understand the API Portal, API usage methods, or general concepts.

Contents

Using Frequently Asked Questions

Defined questions are displayed on the “Frequently Asked Questions” page on the API Developer Portal.

Users can filter frequently asked questions by category in this area and review detailed answers.

This structure enables:

  • API consumers to find quick solutions to common issues,
  • Reduced support workload,
  • Enhanced ease of use and guidance capabilities of the portal.

A visual representation of the FAQ list screen details is provided below:


Field

Description

Question

This is the text of the frequently asked question in English. 
This field is displayed when the user's language preference in the API Portal is English.

Answer

This is the text of the answer to the question. It should be explanatory and informative.

Category

The category is selected here based on the topic of the question.

Question(TR)

Displayed when multilingual support is active. The Turkish version of the question is entered in this field.

Answer(TR)

Displayed when multilingual support is active. The Turkish answer to the question is entered in this field.

Category(TR)

This is the Turkish category name. This value is displayed when the portal is viewed in Turkish.

When both the Turkish Language Option and the English Language Option are enabled in the Portal Settings, the system automatically switches to Multilanguage mode.

If the Multilanguage feature is enabled in the Portal Settings, form fields are displayed in both English and Turkish, and separate data entry can be made in each language.

Creating a New Question

To create a new frequently asked question, click the Create (+) button in the upper right corner of the screen. In the window that opens (modal), complete the registration process by filling in the fields below. After filling in the required fields (marked with an asterisk (*)), click the Save button to add the record to the system.

A visual representation of the Frequently Asked Questions screen details is provided below:

The fields used for creating the Frequently Asked Questions configuration are shown in the table below.

Step

Description/Function

Step 1: Open the FAQ List screen

Expand the Portal Management heading in the left menu.

Click the FAQ menu item.

Verify that the current questions are listed.

Step 2: Open the New FAQ Form

Click the New FAQ button at the top of the page. The frequently-asked-questions-update component opens as a modal form.
Step 3: Enter the basic information

Enter the question that portal users will see in the Question field.

Enter the detailed answer in the Answer field using Markdown support (paragraphs, lists, links can be used).

Select an existing category from the Category field or create a new category if the option is available.

Step 4: Save Ensure that all required fields (Question, Answer, Category) are complete. Click the Save button. The request is sent to the POST /api/portal/faq endpoint (PUT for updates).

Appearance on the Portal Interface

 Every question you save in Manager is automatically reflected on the FAQ page on the portal side. When the portal page is opened, the system pulls the latest questions and displays them in an accordion format, categorized as shown in the screen below.

  • Category Tabs: Based on the category you select in Manager, tabs (All, Education, Portal, etc.) automatically appear at the top of the portal.
  • Accordion Structure: When a user clicks on a question, they see the expanded answer. Content entered with Markdown retains formats such as bold text, lists, and links.
  • Language Support: When you change the portal language between TR/EN, only FAQ records created in that language are listed. If you want to view a different language, you must open a separate record for that language in Manager.

How Does Data Flow Work in the Portal Application?

Manager → Portal Synchronization (User Perspective)

  1. Save in Manager: When you create an FAQ record and save it by leaving it Active, it is written to the knowledge base database.
  2. Open Portal Page: When a portal user enters the FAQ menu, the screen automatically loads all currently registered active questions.
  3. Categories are Created Automatically: The category names you provide in Manager appear as tabs at the top of the portal; when the user clicks on a tab, they only see questions belonging to that category.
  4. Instant Updates: When you deactivate a question in Manager or change its answer, the new content is immediately reflected when the portal page is refreshed. No extra publishing step is required.
  5. Language Compatibility: For multilingual portals, remember to add separate entries for each language. When the portal language is changed, questions in that language are displayed; other languages are hidden.