Introduction
API Developer Portal is an end-user or developer portal where API Consumers can access documentation related to APIs offered by an organization, test them, use them within certain limitations, and ask and answer questions about these topics. API Developer Portal, like other Apinizer products, runs on Kubernetes Platform. No database is used for Portal operations, instead interaction is provided directly with APIs provided by API Manager.Pre-Installation Steps
Before starting the installation of Apinizer API Portal, the following should be noted:Installation Steps
API Portal Installation is done in two ways.- If Kubernetes management is done through Apinizer, you can install API Developer Portal through API Manager.
- If Kubernetes management is not done through Apinizer, manual installation can be done to Kubernetes and then connection can be established with API Manager.
Creating Token for Personal API Access
Token information can be obtained by creating a new token or using an existing token on the My Profile page. Staff tokens usually start with theapnz_ prefix.
To create a token, you can go to the My Profile page in API Manager and create a new token.

Token creation - Creating personal API token from My Profile page
API Developer Portal Installation
If API Developer Portal Installation Will Be Done Through API Manager
For API Developer Portal installation through API Manager, the following section must be active in the General Settings menu. In API Manager, go to Administration → Server Management → Kubernetes Resources page. Enable API Portal from the Deployment & Pods tab. Complete the installation by making the necessary definitions.
Kubernetes Resources page - API Portal enablement

API Portal installation dialog - Configuration of required settings

API Portal settings - API Manager integration configuration
| Field | Description |
|---|---|
| Apinizer Portal Management API URL | Management API address run by API Manager required for API Developer Portal to consume Apinizer Management APIs. Example address: http://<API_MANAGER_ACCESS_URL>:<PORT>/ |
| Apinizer Portal Management API Key/Token | Token information required for API Developer Portal to consume Apinizer Management APIs. |
| Count (Count) | Gateway engine count, adjusts the replicaSet setting in Kubernetes Cluster. |
| Service Port (Service Port) | Gateway engine access port, adjusts the NodePort setting of the service object in Kubernetes Cluster. |
| Node List (Node List) | Sets which Kubernetes Worker servers the Pods will run on. Adjusts the NodeAffinity setting in Kubernetes. |
| CPU | Information about the maximum CPU core count the Pod will use. |
| Memory (Memory) | Maximum memory value the Pod will use. |
| Memory Unit (Memory Unit) | The unit of the value required for memory is selected; MB, GB. |
| Additional Variables (Additional Variables) | Default and optional variables and values to be run in the Pod are defined. Default variables cannot be deleted, only their values can be edited. |
| Host Aliases (Host Aliases) | IP addresses in the network can sometimes be placed behind host names, if these are not defined in nameserver or host file or cannot be resolved by Apinizer in some way, Host Alias definition must be made for worker pods to resolve these names. |
Additional VariablesWhen configuring the Java Options setting in the Additional Variables field, the following warning should be considered:
- When -Xmx and -Xms parameters are used, automatic heap sizing is disabled.
- Apinizer sets JVM Heap values to use 75.0% of the memory given to the container since it runs inside the container.
- UseContainerSupport is active by default.
- Old flags
-XX: {Min | Max} RAMFractionare now deprecated. There is a new-XX: MaxRAMPercentageflag that takes a value between 0.0 and 100.0 and defaults to 75.0. Therefore, if there is a 1 GB memory limit, the JVM heap is limited to ~ 750 MB by default.
If API Developer Portal Installation Will Not Be Done Through API Manager
The following steps should be followed for manual installation of API Developer Portal.- apinizerManagementApiBaseUrl: Management API address running on API Manager required for API Developer Portal to consume Apinizer Management APIs. An example address:
http://apimanager-ui-ip-address:port - apiKey: Token information required for API Developer Portal to consume Apinizer Management APIs.

