Skip to content

Environment Setup ​

Connection Settings ​

SettingValueDescription
ProtocolHTTP
HostGateway IP addressUse the gateway's LAN address, returned by gateway discovery. 127.0.0.1 refers to your own machine.
Port8080
Base path/

Authentication Settings ​

Authenticate requests by sending your gateway credential in the application-key header.

SettingValueDescription
Authentication typeAPI KeyObtain a credential by registering your application.
Add toHeaderInclude the credential in every authenticated request.
Keyapplication-keyThe HTTP header name.
ValueRegistration credentialUse the value returned as data.obj.username. See Authentication for details.

Configure Authentication in Apifox ​

  1. Open the request's Auth settings.
  2. Select API Key as the authentication type.
  3. Set Key to application-key and Value to the credential returned by the gateway.
  4. Set Add to to Header.

The screenshot shows the Chinese version of Apifox; use the settings above if your interface is in English.

Apifox API Key authentication settings in the Chinese interface