REST API
Any HTTP API, described by a base URL and an auth scheme. Most other software is reached this way rather than through a type of its own.
APIs and messaging · type rest
Connect it
Open Portal → Connections, choose Add,
then REST API, and fill in its settings and its credential. The portal sends
the one request every type uses, with
"type": "rest". The credential goes in credential.secret; for this
type it is the secret.
The settings, the credential and a ready example body, from the public type catalog (no key needed):
GET https://api.docbutterfly.com/api/connection-types/rest
GET https://api.docbutterfly.com/api/connection-types/rest/schema
Operations
Each operation is an API call that names the connection. Reads bring data in from REST API; writes send data or files out to it.
Read
-
RestRequest (GET, HEAD)REST Request
Write
-
RestRequest (POST, PUT, PATCH, DELETE)REST Request