Getting Started-Community

Changing IP Configuration

You should change the default value of Apinizer’s IP according to your configuration. The variable you need to change is APINIZER_IP. For Example: export APINIZER_IP=

$ vi


Starting The APINIZER

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

Linux :APINIZER can be started to click 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: Apinizer.1

Manager Login Screen

Editing Server Information

You must change the existing 3 server information according to your own information.

Editing username and password fields

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


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