TRANXACT.AI Help

Platform · Integration

Connections

A connector configured against a real system — over HTTPS, or directly over the network (a VPN or interconnect) to a database, directory or service port. Every handshake is TLS 1.2 or higher and the server is verified, against a trusted root or a CA you upload under Certificates. Credentials are encrypted on the way in and never come back out — only the last four characters are ever shown. A connection here carries data; it does not place Microsoft Teams calls or create meetings — those run through CRM › Interaction Centre › Connected Channels, and testing a Teams connection here says what that still lacks.

Type REST9 operationsBase path /api/platform/connectionsPublished as /api/v1/connections

Download specification (OpenAPI 3.1) Screen: Connections

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Platform › Connections on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableplatform.connections · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

9 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/connectionsList connections

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "connector_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "environment": "text",
      "base_url": "https://example.com",
      "username": "Example",
      "secret_cipher": "text",
      "secret_last4": "text",
      "config": {},
      "status": "draft",
      "last_tested_at": "2026-10-30T09:00:00Z",
      "last_test_ok": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/platform/connections?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/platform/connections/{id}Read one connections

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "connector_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "environment": "text",
  "base_url": "https://example.com",
  "username": "Example",
  "secret_cipher": "text",
  "secret_last4": "text",
  "config": {},
  "status": "draft",
  "last_tested_at": "2026-10-30T09:00:00Z",
  "last_test_ok": true
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/platform/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/connectionsCreate a connections

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesConnection code
nametextYesName
connector_iduuidYesConnector
environmenttextNoEnvironment
base_urltextNoEndpoint URL — HTTPS only (TLS 1.2 or higher), in every environment. For a https connection.
usernametextNoUsername — Basic authentication only.
configjsonbNoConfiguration
statustextNoStatus
owner_iduuidNoOwner
transporttextNoTransport — https = an endpoint URL. direct = straight to a host and port over the network (VPN, interconnect, peering) — a database, a directory, a service port.
Allowed: https direct
hosttextNoHost — For a direct connection: the name or address only, e.g. hana.corp.local or 10.20.0.15.
portintegerNoPort — For a direct connection, e.g. 5432 PostgreSQL, 1433 SQL Server, 30015 HANA, 636 LDAPS.
direct_protocoltextNoProtocol — tls = TLS from the first byte (LDAPS, HANA, SQL Server with strict encryption, SMTPS, AMQPS, Kafka). postgres = PostgreSQL, which negotiates TLS on connect.
Allowed: tls postgres
server_nametextNoServer name — Only when the certificate names a different host from the one connected to (SNI and verification).
tls_min_versiontextNoLowest TLS version — TLS 1.2 is the floor; nothing older can be chosen.
Allowed: TLSv1.2 TLSv1.3
ca_certificate_iduuidNoTrusted CA — For a server whose certificate is issued by your own CA. Empty = the public roots.
client_certificate_iduuidNoClient certificate — Presented to the server (mutual TLS). Needs its private key stored.
pin_sha256textNoPinned fingerprint — Optional. The server certificate’s SHA-256 fingerprint; any other certificate is refused.

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "connector_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "environment": "text",
  "base_url": "https://example.com",
  "username": "Example",
  "config": {}
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "connector_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "environment": "text",
  "base_url": "https://example.com",
  "username": "Example",
  "secret_cipher": "text",
  "secret_last4": "text",
  "config": {},
  "status": "draft",
  "last_tested_at": "2026-10-30T09:00:00Z",
  "last_test_ok": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/connections" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","connector_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","environment":"text","base_url":"https://example.com","username":"Example","config":{}}'
PUT/api/platform/connections/{id}Change a connections

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesConnection code
nametextYesName
connector_iduuidYesConnector
environmenttextNoEnvironment
base_urltextNoEndpoint URL — HTTPS only (TLS 1.2 or higher), in every environment. For a https connection.
usernametextNoUsername — Basic authentication only.
configjsonbNoConfiguration
statustextNoStatus
owner_iduuidNoOwner
transporttextNoTransport — https = an endpoint URL. direct = straight to a host and port over the network (VPN, interconnect, peering) — a database, a directory, a service port.
Allowed: https direct
hosttextNoHost — For a direct connection: the name or address only, e.g. hana.corp.local or 10.20.0.15.
portintegerNoPort — For a direct connection, e.g. 5432 PostgreSQL, 1433 SQL Server, 30015 HANA, 636 LDAPS.
direct_protocoltextNoProtocol — tls = TLS from the first byte (LDAPS, HANA, SQL Server with strict encryption, SMTPS, AMQPS, Kafka). postgres = PostgreSQL, which negotiates TLS on connect.
Allowed: tls postgres
server_nametextNoServer name — Only when the certificate names a different host from the one connected to (SNI and verification).
tls_min_versiontextNoLowest TLS version — TLS 1.2 is the floor; nothing older can be chosen.
Allowed: TLSv1.2 TLSv1.3
ca_certificate_iduuidNoTrusted CA — For a server whose certificate is issued by your own CA. Empty = the public roots.
client_certificate_iduuidNoClient certificate — Presented to the server (mutual TLS). Needs its private key stored.
pin_sha256textNoPinned fingerprint — Optional. The server certificate’s SHA-256 fingerprint; any other certificate is refused.

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "connector_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "environment": "text",
  "base_url": "https://example.com",
  "username": "Example",
  "secret_cipher": "text",
  "secret_last4": "text",
  "config": {},
  "status": "draft",
  "last_tested_at": "2026-10-30T09:00:00Z",
  "last_test_ok": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/platform/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/platform/connections/{id}Delete a connections

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/platform/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/connections/{id}/testTest

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/connections/{id}/discoverDiscover

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

port

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/discover" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"port":"value"}'
POST/api/platform/connections/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/platform/connections/{id}/secretSecret

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/platform/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/secret" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a connections, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeConnection code
nametextread, writeName
connector_iduuidread, writeConnector
environmenttextread, writeEnvironment
base_urltextread, writeEndpoint URL — HTTPS only (TLS 1.2 or higher), in every environment. For a https connection.
usernametextread, writeUsername — Basic authentication only.
secret_cipherbytearead onlySecret cipher
secret_last4textread onlySecret last4
configjsonbread, writeConfiguration
statustextread, writeStatus
last_tested_attimestamp with time zoneread onlyLast tested at
last_test_okbooleanread onlyLast test ok
last_test_messagetextread onlyLast test message
owner_iduuidread, writeOwner
created_attimestamp with time zoneread onlyCreated at
transporttextread, writeTransport — https = an endpoint URL. direct = straight to a host and port over the network (VPN, interconnect, peering) — a database, a directory, a service port.
Allowed: https direct
hosttextread, writeHost — For a direct connection: the name or address only, e.g. hana.corp.local or 10.20.0.15.
portintegerread, writePort — For a direct connection, e.g. 5432 PostgreSQL, 1433 SQL Server, 30015 HANA, 636 LDAPS.
direct_protocoltextread, writeProtocol — tls = TLS from the first byte (LDAPS, HANA, SQL Server with strict encryption, SMTPS, AMQPS, Kafka). postgres = PostgreSQL, which negotiates TLS on connect.
Allowed: tls postgres
server_nametextread, writeServer name — Only when the certificate names a different host from the one connected to (SNI and verification).
tls_min_versiontextread, writeLowest TLS version — TLS 1.2 is the floor; nothing older can be chosen.
Allowed: TLSv1.2 TLSv1.3
ca_certificate_iduuidread, writeTrusted CA — For a server whose certificate is issued by your own CA. Empty = the public roots.
client_certificate_iduuidread, writeClient certificate — Presented to the server (mutual TLS). Needs its private key stored.
pin_sha256textread, writePinned fingerprint — Optional. The server certificate’s SHA-256 fingerprint; any other certificate is refused.
last_handshakejsonbread onlyLast handshake
direct_reachablebooleanread onlyDirect reachable
direct_checked_attimestamp with time zoneread onlyDirect checked at
direct_probejsonbread onlyDirect probe
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
exception_overridejsonbread onlyException override
credential_kindtextread onlyCredential kind
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › Connections for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.