Custom API sources
Detailed explanation of Endpoint, request, authentication, field mapping and result display.
Name
A recognizable provider name.
Example: My Product API
Endpoint URL
The API endpoint used for search requests.
Example: https://api.example.com/search
Method
Choose GET or POST according to the API documentation.
Request format
Choose query parameters, POST form or POST JSON to match the provider.
Search query parameter
The parameter that receives the visitor's search text.
Examples: q, query, search
Timeout seconds
Maximum time DoorFall should wait for this API. Keep this reasonably low so an external provider cannot make your search page feel slow.
Authentication type
Choose the method required by the API: none, API key/header, Bearer token or the available credential method.
Only enter credentials supplied by the provider.
Token / Username / Password
Authentication values used by the selected method.
Header / parameter name
Example: X-API-Key or api_key.
Auth value
The corresponding credential value.
Request headers
Optional JSON object for fixed headers.
Example: {"Accept":"application/json"}
Static parameters
Optional JSON object sent with every request.
Example: {"language":"en","limit":10}
Results path
Dot path to the array of results inside the JSON response.
Example: data.items
Title / URL / Description fields
Dot paths within each result object.
Examples: name, url, description
Image / Price / Extra fields
Optional display fields.
Examples: image.large, price.display, category
Save & Test API
Use a realistic Test search. DoorFall can inspect the JSON response and suggest likely fields. If the API responds but no results appear, the Results path or field mapping is usually wrong.
Placement
Choose before web results, after web result #3, or after web results.
Result type
Choose Organic or Sponsored / Affiliate according to the nature of the provider/results.
Maximum API results
Limits how many results this provider can contribute.