Press the "Publish API" button to save and publish the API you have created.
Saving the API will allow you to revisit this API and modify it later, if necessary.
Press the "Delete API" button to delete and API permanently.
If the "Delete Api" button is pressed unintentionally then press the "Save API" button before moving to a different screen. Pressing the "Save API" button will save the API once again without requiring you to re-create the API
Press the "Add API" button to add a new API Endpoint.
The "Add API" button is only visible when you are viewing an existing API Endpoint. Pressing the "Add API" button will take you to "New Endpoint" view where you can define/create a new API Endpoint.
This button indicates that simulation mode is disabled for the API Endpoint that is displayed on the screen. Pressing this button will switch-on simulation mode for this API Endpoint.
Simulation mode for each API Endpoint has to be switched-off individually.
Simulation is off by default
This button indicates that simulation mode is enabled for the API Endpoint that is displayed on the screen. Pressing this button will switch-off simulation mode for this API Endpoint.
Simulation mode for each API Endpoint has to be switched-on individually.
To enable simulation, there must be atleast one alternate response defined for the API Endpoint
OR
A value greater than 0 milliseconds must be provided in the "Delay Simulation" section
This list contains the HTTP Methods or Verbs. You must one of the methods from this list.
The available options are: GET, POST, PUT, DELETE
You will not be able to save an API Endpoint without picking a value from this list
The value displayed in this text field is the unique identifier of the API Endpoint.
The unique identifier is generated automatically and it cannot be modified.
The unique identifier stays with the API Endpoint until the Endpoint is deleted
API Path is a required field and an API Endpoint cannot be saved or published without it.
API Path must always begin with a forward slash.
There is no need to enter Host and Port information in this text field.
Some examples of API Paths are provided below:
/product/id/100
/order/number/44556677
/info/item/12
/type/suv/year/2020
If there are variables in the Path then the variables can be replaced by an asterisk, for example:
/product/id/*
/order/number/*
/info/item/*
/type/*/year/*
Let us assume that an API Consuming Application calls /product/id/33
Api-On-Cloud will map the call to /product/id/* because asterisk is interpreted as a placeholder for variable values
Similarly, if an API Consuming Application calls /type/sedan/year/2019
Api-On-Cloud engine will map that call to /type/*/year/*
It is a read-only field that displays the complete URL of the API Endpoint.
If the Path contains one or more variables then this text field will display an asterisk for every variable in the path
For example, if the the API Path is defined as: /type/*/year/*
then, the Complete API Endpoint URL will displayed: https://app.apioncloud.com/live/zh6jz/type/*/year/*
When there are path variables, please make sure that you or your application code replaces the asterisk with the actual data
The subdomain and base path used may vary from one subsrcription to another. Please do not use the subdomain and base path shown here.
The subdomain value shown here is: app
The base path value shown here is: /live/zh6jz
Click this button to copy the url shown in the Complete API Endpoint URL text field
Press the 'Test API Endpoint' button to launch the built-in API testing feature. This button can be pressed only after saving/publishing the API.
Press the 'Test API' button to test if the API is functioning and responding with the expected response.