API Key
API Key authentication lets you send a key as either a custom HTTP header or a URL query parameter. The placement depends on what your API requires.
- Open a request and click the Auth tab.
- Select API Key from the type dropdown.
- Fill in the three fields:
- Key: the header name or query parameter name (e.g.,
X-API-Key,api_key) - Value: your API key
- Add to: choose Header or Query Param
- Key: the header name or query parameter name (e.g.,
Header Placement
Section titled “Header Placement”The key is sent as a custom HTTP header:
GET /api/data HTTP/1.1Host: api.example.comX-API-Key: your-api-key-hereMost APIs that use header-based keys follow naming conventions like X-API-Key, X-Auth-Token, or Authorization. Check your API’s documentation for the expected header name.
Query Parameter Placement
Section titled “Query Parameter Placement”The key is appended to the request URL:
GET /api/data?api_key=your-api-key-here HTTP/1.1Host: api.example.comThe URL bar in Nouto updates to show the appended parameter when you switch to Query Param placement.
Variable Support
Section titled “Variable Support”Both the key name and value accept {{variable}} syntax:
| Field | Example | Resolved value |
|---|---|---|
| Key | {{API_HEADER_NAME}} |
X-API-Key |
| Value | {{API_KEY}} |
sk-abc123... |
This works with environment variables, global variables, .env file variables, and dynamic variables.
cURL Export
Section titled “cURL Export”API Key auth is included when you copy a request as cURL.
Header placement:
curl https://api.example.com/data \ -H 'X-API-Key: your-api-key-here'Query parameter placement:
curl 'https://api.example.com/data?api_key=your-api-key-here'Postman Compatibility
Section titled “Postman Compatibility”- Import: Postman collections using
apikeyauthentication are imported with key name, value, and placement preserved. - Export: Nouto API Key auth exports to the standard Postman
apikeyauth format for round-trip compatibility.
Security
Section titled “Security”When sending an API key over unencrypted HTTP to a non-localhost URL, Nouto shows a security warning. Query parameter placement exposes the key in server logs, browser history, and referrer headers. Prefer header placement when security matters.
