# HTTP Gateway

Table of Contents

As part of the Airnode deployment you can decide to deploy an HTTP Gateway. The gateway allows the testing of defined Airnode endpoints without accessing the blockchain. You provide endpoint arguments directly to the Airnode with a tool. of your choice and get a response from an integrated API operation. This results in confirmation your integration is set up properly. The HTTP gateway feature is only available when deploying an Airnode to a cloud provider's serverless service.

HTTP Gateway (optional)

Using the HTTP gateway functionality with Airnode is optional.

# Setup

Enable the HTTP gateway by setting two fields in the config.json (nodeSettings.httpGateway).

enabled: A boolean setting enable/disable for the Airnode's HTTP gateway.
apiKey: A user defined API key to authenticate against the gateway. The key must have a length of between 30 - 120 characters.

"nodeSettings": {
  "cloudProvider": "aws",
  "airnodeWalletMnemonic": "${AIRNODE_WALLET_MNEMONIC}",
  "heartbeat": {...},
  "httpGateway": {
    "enabled": true,
    "apiKey": "${HTTP_GATEWAY_API_KEY}"
  },
  ...
},

1
2
3
4
5
6
7
8
9
10

You must also add the testable boolean flag for each endpoint you want to test in the OIS (ois.endpoints[n]testable). This indicates whether the endpoint can be used via HTTP gateway or not. It’s optional and by default is false.

// in config.json
// ois.endpoints[n].testable
"ois":{
  "endpoints":[
  {
    "name": "convertToUSD",
    "operation": {...},
    "testable": true,
    ...
  ]
  ...
}

1
2
3
4
5
6
7
8
9
10
11
12

# Gateway URL

A gateway URL is generated when your Airnode is deployed. You can obtain the URL (api.httpGatewayUrl) from the receipt.json file returned by the deployer or as part of a request sent from Airnode's heartbeat to your specified heartbeat URL.

# Using CURL

In order to test an endpoint, via the HTTP gateway, make an HTTP POST request with endpointId as a path parameter, the x-api-key in the header and endpoint parameters in the request body. As an alternative to CURL try an app such as Insomnia (opens new window) or Postman (opens new window). Windows users can also use Windows Subsystem for Linux (opens new window) (WSL2) to run CURL for Linux.

An endpointId can found in config.json under triggers[n].endpointId.
The x-api-key can found in config.json under nodesettings.httpGateway.apiKey.

parameter	in	CURL options
x-api-key	header	`-H 'x-api-key: 8d890a46-799d-48b3-a337-8531e23dfe8e'`
endpointId	path	`0x6db9e3e3d...c7025f5c27af6`
<user-defined>	body	`-d '{"parameters": {"param1": "string", "param2": 5}}'`

Replace <httpGatewayUrl> in the example below with your gateway URL from the receipt.json file using the httpGatewayUrl field. The receipt.json file is created when you deploy an Airnode.

Request:

Response:

{ "value": "some string" }

The response format is a simple JSON object: {"value": <return value>}.

← Heartbeat (optional) Deploying Airnode →