Skip to main content

HTTP / REST API

Send to, or poll, any HTTP endpoint - JSON, XML, HL7 or FHIR in the body.

Web↓ Inbound↑ Outbound
Type codeHTTP_REST
Camel componentcamel-http
Formats carried
HL7 v2FHIR R4JSONXMLCSV
Terms used on this page

HL7 - Health Level Seven - the standard family for exchanging healthcare messages · FHIR - Fast Healthcare Interoperability Resources - a modern web API standard for health data · REST - a common style of web API using plain HTTP · API - application programming interface

See the Glossary for every term.

Test connection always uses GET

Even when Method is POST or PUT, the test sends a GET (to the health path, or to the URL itself) and never a POST, so it cannot create anything on the other side.

Worked example​

Demo REST endpoint (this engine) · Outbound · JSON · Test passes on any engine: Yes

Points at this engine itself, only so Test has something real to reach. Use the partner's URL for real.

Values entered by Fill example
{
"direction": "Outbound",
"format": "JSON",
"settings": {
"url": "http://localhost:8080",
"method": "POST",
"auth": "NONE",
"healthPath": "/",
"pollSeconds": "60"
}
}

This is what the console's Fill example button enters. Secrets are never part of an example. Every setting is explained below.

Settings​

Required fields are marked Yes. Fields marked 🔒 (password, token, apiKey) are stored encrypted and never sent back to the browser - the console only shows Set / Not set. A field marked inbound only or outbound only appears just for that direction.

SettingTypeRequiredDefaultWhat to enter
url
URL
textYeshttps://Required: the full address messages go to (or are read from), e.g. https://portal2.example.org/fhir/R4/Bundle.
method
Method
selectYesPOSTPOST - send a new message (usual for orders and results) · PUT - send to replace an existing one · GET - read from it every N seconds (polling). The test always uses GET. Options: POST, PUT, GET.
auth
Authentication
selectYesNONEOnly the fields for the chosen type are shown. All four work for sending. Options: NONE, BASIC, BEARER, API_KEY.
username
Username
textNo—Required for Basic: the account name the receiver gave you, e.g. xellabs-engine.
password
Password
passwordNo—🔒 secret. Required for Basic: that account's password. Stored encrypted; shown only as Set / Not set.
token
Bearer token
passwordNo—🔒 secret. Required for Bearer: the token the receiver issued, sent as Authorization: Bearer <token>.
apiKeyHeader
API key header
textNoX-API-KeyThe header name the receiver reads the key from, e.g. X-API-Key.
apiKey
API key
passwordNo—🔒 secret. Required for API key: the key the receiver issued. Stored encrypted.
healthPath
Health check path
textNo—Optional: a path Test connection reads, e.g. /health. Blank tests the URL itself with a GET.
pollSeconds
Poll every (seconds)
numberNo60How often to read the URL, e.g. 60 (seconds). GET only.

What "Test connection" checks​

The address answers and the credential is accepted, by a GET on the health path. Never a POST.

Test connection is read-only and says how far it got: verified, reached, checked or failed. See Testing a connection, and Troubleshooting if it fails.