Connectors

Base URL: $PUBLIC_API

The object

keystring · required

Stable connector key

kindstring · required

Connector kind, for example payment, messaging or meter

namestring · required

Display name

descriptionstring · required

Short description for an integrations directory

markstring · optional

URL path of the connector's mark image; omitted when it has none

capabilitiesarray of string · required

What the connector supports

The object
{
  "key": "key",
  "kind": "active",
  "name": "Ana Matsinhe",
  "description": "Leitura confirmada no local.",
  "mark": "mark",
  "capabilities": [
    "capabilitie"
  ]
}

Connectors enabled on this installation

Logs

GET /connectors

Lists the connectors this installation has enabled (for example payment, messaging and meter connectors), for an integrations directory. Each entry is the connector's public descriptor: key, kind, display name, description and capabilities, plus a mark URL when the connector has a mark image. Connectors are registered at runtime, so the list differs between installations; disabled and development-only connectors are left out. Sorted by kind, then key. No sign-in is needed; responses may be cached for 5 minutes.

Returns

200 Enabled connectors

Show attributes
dataarray of PublicConnector · required

Enabled connectors sorted by kind

Show child attributes
keystring · required

Stable connector key

kindstring · required

Connector kind, for example payment, messaging or meter

namestring · required

Display name

descriptionstring · required

Short description for an integrations directory

markstring · optional

URL path of the connector's mark image; omitted when it has none

capabilitiesarray of string · required

What the connector supports

curl -X GET "$PUBLIC_API/connectors"
Response 200
{
  "data": [
    {
      "key": "key",
      "kind": "active",
      "name": "Ana Matsinhe",
      "description": "Leitura confirmada no local.",
      "mark": "mark",
      "capabilities": [
        "capabilitie"
      ]
    }
  ]
}

A connector's mark image

Logs

GET /connectors/{key}/mark

Returns the raw mark image registered for a connector, with the content type it was registered with (for example image/svg+xml or image/png). Use the mark URL from the connector list rather than building it. A key with no registered mark returns 404. No sign-in is needed; responses may be cached for 5 minutes.

Parameters

keystring · path · required

Connector key as returned by the connector list (case-insensitive).

Returns

200 Mark image bytes

Errors 404

curl -X GET "$PUBLIC_API/connectors/{key}/mark"
Response 200

Mark image bytes