Getting Started


APINIZER can be started to click startApinizer.bat file after configuration settings are done.

Accessing the Management Console


The management console is a web-based application that manages all the capabilities of Apinizer. The user can log in with their user name and password through this panel and can easily manage Apinizer related operations.

If you have completed the previous steps successfully, the Apinizer Management console should be available at the address http://your-ip:8090/apinizer.

username: [email protected]

password: ******** (Ask your Apinizer consultant for support.)

Manager Login Screen

Configuration


The configuration steps cover the configurations that must be made after apinizer is installed.

Configuration Steps

If the configuration isn’t finished, a warning icon will appear at the top of the manager panel. After clicking the icon, a dialog will open with a list of unfinished configuration steps. Once the step is complete, the warning icon(s) will turn into green check marks. When all steps are complete the warning icon at the top of the manager panel will also disappear.

Configuration Warning Icon

The configuration steps are as follows:

  • Load Balancer’s external URL
    • Load balancer’s external URL is the hostname or IP address of the load balancer.
  • Creating a Log Server
    • Log server is the server that logs the operations of the web services on Apinizer.
  • Creating a Load Balancer Server
    • Load Balancer is the server that distributes the incoming requests between servers.
  • Creating a Gateway Server
    • Gateway servers are used to separate the APIs in internal servers with the outside world.

Setting External Access URL


The External Access URL field must be set before APINIZER processes.

Figure: Setting External Access URL

Defining Load Balancer Server


A load balancer is needed for distributing requests coming to the gateway server from clients. This page will show you how to set up a load balancer server.

  • Step 1: Creating a Load Balancer Server
    • In the New Server screen, pick Load Balancer in the Server Type choice box.

      Load Balancer Creation Form

  • The Server Name and Host Name/ IP Address fields should be filled with the right info for your environment.

  • After the necessary values are entered the “Save and Verify” button should be clicked to save the changes.

When defining a load balancer server, the below requirements must be met:
  • The server name must be unique.
  • Hostname/ IP Address should match the “Cache Interface Block” value in system settings.
  • The hostname/ IP Address should be available.
  • The port should be available.
  • The directory shouldn’t be occupied by another server.

There has to be at least one load balancer server in the system.

  • Step 2: Setting up Load Balancer Server
    • Once the Save and Verify button is clicked, info about verification will appear on the right side of the page.
    • The checks that are complete will be marked with green check marks.
    • When all conditions are met, the Check Manual Install and Start Automatic Install buttons will become available.

      Successful Install of a Load Balancer Server

Defining Log Server


A log server is used to record logs about the web services running on Apinizer.

Step 1: Creating a Log Server

  • To define a log server, you must select the “Log Server” option while creating a server in the new server screen

    Log Creation Form

  • The Server Name and Host Name/ IP Address fields should be filled with the right info for your environment.

  • After the necessary values are entered the “Save and Verify” button should be clicked to save the changes.

When defining a log server, the below requirements must be met:
  • The server name must be unique.
  • The hostname/ IP Address should be available.
  • The Log Transport Port and Log HTTP Ports should be available.
  • The directory shouldn’t be occupied by another server.

Step 2: Setting up Log Server

  • Once the Save and Verify button is clicked, info about verification will appear on the right side of the page.

    • The checks that are complete will be marked with green check marks.
    • When all conditions are met, the Check Manual Install and Start Automatic Install buttons will become available.

      Successful Install of a Log Server

  • If the install is going to be done manually, the necessary files must be places in their respective directories manually. Then the Check Manual Install button can be used to check if the manual install was done correctly. Alternatively, you can just use the automatic install button.

Defining Gateway Server


Gateway servers are used to separate the APIs in internal servers with the outside world.

Step 1: Creating a Gateway Server

  • To define a gateway server, you must select the “Gateway Server” option while creating a server in the new server screen

    Gateway Server Creation Form

  • The Server Name and Host Name/ IP Address fields should be filled with the right info for your environment.

  • After the necessary values are entered the “Save and Verify” button should be clicked to save the changes.

When defining a gateway server, the below requirements must be met:
  • The server name must be unique.
  • Hostname/ IP Address should match the “Cache Interface Block” value in system settings.
  • The hostname/ IP Address should be available.
  • The port should be available.
  • The directory shouldn’t be occupied by another server.

Step 2: Setting up the Gateway Server

  • Once the Save and Verify button is clicked, info about verification will appear on the right side of the page.

    • The checks that are complete will be marked with green check marks.
    • When all conditions are met, the Check Manual Install and Start Automatic Install buttons will become available.

      Successful Install of a Gateway Server


  • If the install is going to be done manually, the necessary files must be places in their respective directories manually. Then the Check Manual Install button can be used to check if the manual install was done correctly. Alternatively, you can just use the automatic install button.

Before you’re able to add a gateway server, you must first have a load balancer and log server in the system.

Defining API with Swagger 2.x file


API List is a section on defining SOAP and REST APIs on the Apinizer platform.

Figure: API List

Swagger 2.x

After selecting Swagger 2.x , Select source of the file option will be activated.There are Import from URL and Upload the file options.If you select Import from URL,you must enter the URL of the Swagger 2.x file.If you select Upload the file, you must define Swagger 2.x file from local file system.

Figure: Swagger 2.x URL Define

  • In the Swagger 2.x file imported with the URL, click the gear icon at the end of the URL entry and perform Swagger 2.x parsing.

  • The REST API is created by clicking the Save button.

    Figure: Swagger 2.x URL Define After Parsing

Creating New Gateway


  • To create a new gateway, click the New Gateway   button on the Gateways page.
  • In the screen that opens, the API to create the gateway is selected.
    • With the search bar you can search by name information of the API.
    • Or click the Select API   button on the screen. Clicking the button opens the API Search   window. Click the API   button of the corresponding API in the window. New API can be added from the Go to New API   page button in this window.

Figure: Search API Screen

  • As a result of this process, click the Create Gateway   button in the lower right corner of the Gateway screen.

Figure: Creating Gateway Page

  • It is mandatory to enter the Name and Gateway Address on the Basic Information screen.

Figure: Basic Information Screen

  • After the basic information is registered, the policy definitions are made by saying Go to Configuration.

The screens encountered when creating a new gateway should not be confused! During the process of creating a gateway, the process is performed on three screens: API selection, Basic Information and Gateway Formatting. Gateway Screen, This screen is displayed with API methods after selecting API when creating a new gate. We face with this screen when gateway is created. The Basics Screen is the screen where gateway information is found and managed.Adding policies and managing policies, setting message logs, adding and editing SLA and Action, changing the status of the gate, managing gate methods, etc. operations are performed on Gateway Configuration screen. Click here for a description of this screen.

Adding Policy to Gateway


The Authentication policy allows clients to access the requested resource within the authorized permissions.

Figure: Authentication Policy

JWT

JSON Web Token (JWT) is a more compact and self-described standard by using a JSON object (token) to provide secure data exchange between two or more communicating systems (Web, Mobile, IOT, Cloud, etc.).

  • Sample JWT request: POST http :// {api-gateway-address}:8010/auth/jwt?grant_type=password&username={your-username}&password={password}&client_id={api-key}&client_secret=-&auth_type=basic
  • After the Token response is obtained, we use the access_token parameter and value to access the resource.

Figure: Sending a request to the source after obtaining token