Skip to main content

Creating a "Blank" API in NoCode-X

Creating a "Blank" API allows you to define an API from scratch with custom settings and properties. Follow these instructions to create and configure your API.

Steps to Create a "Blank" API​

  1. Click the API icon in the side navigation bar.

  2. Click Create in the API overview section.

  3. Select BLANK as the type of API to create.

  4. Provide the following details:

    • Name: Enter the API name.
    • Description: Write a brief overview of the API's purpose.
    • Icon: Choose or upload an icon for recognizability.
    • Tags: Add tags for better identification in NoCode-X.

  5. Choose the Method (HTTP method) to be used by the API:

    • GET
    • POST
    • PUT
    • DELETE

  6. Set the Endpoint path. Ensure it is unique within your application. This path will be used with domain settings for different environments (DEV, TEST, ACCEPT, PRODUCTION). Example endpoint formats:

    • https://dev-{{APPLICATION DOMAIN}}-{{COMPANY DOMAIN}}.api.nocode-x.com/api/{{API ENDPOINT}}
    • https://test-{{APPLICATION DOMAIN}}-{{COMPANY DOMAIN}}.api.nocode-x.com/api/{{API ENDPOINT}}
    • https://accept-{{APPLICATION DOMAIN}}-{{COMPANY DOMAIN}}.api.nocode-x.com/api/{{API ENDPOINT}}
    • https://{{APPLICATION DOMAIN}}-{{COMPANY DOMAIN}}.api.nocode-x.com/api/{{API ENDPOINT}}

  7. On API Call (Action Trigger):

    • Link existing actions to the API to be triggered when it is called or create a new action by clicking the "create" icon.

  8. Handling The request body:

  • For POST or PUT methods, use a parameter named “REQUEST” of type object to pass the response body.
  1. Handling Query parameters/Headers:
    • Add other parameters to your linked Action to make use of values that are passed as query parameters or Headers. Make sure the name of the parameters are equal to the query parameters/Headers passed in the http request to your API.
  2. Handling Responses:
    • All HTTP methods can include a RESPONSE, which can be set using the function “Set an API Response”.
    • To include a file in the response, use the function “Set an API File Response”.

Table of Properties​

PropertyDescription
NameThe name of the API being created.
DescriptionA summary of what the API does when called.
IconA visual identifier for the API in NoCode-X.
TagsKeywords to help organize and locate the API.
MethodThe HTTP method to be used (GET, POST, PUT, DELETE).
EndpointThe unique path for the API, appended to domain settings based on the environment.