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.
/api/platform/connectionsPublished as /api/v1/connectionsOverview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The 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. |
| Table | platform.connections · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Connection code |
name | text | Yes | Name |
connector_id | uuid | Yes | Connector |
environment | text | No | Environment |
base_url | text | No | Endpoint URL — HTTPS only (TLS 1.2 or higher), in every environment. For a https connection. |
username | text | No | Username — Basic authentication only. |
config | jsonb | No | Configuration |
status | text | No | Status |
owner_id | uuid | No | Owner |
transport | text | No | Transport — 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 |
host | text | No | Host — For a direct connection: the name or address only, e.g. hana.corp.local or 10.20.0.15. |
port | integer | No | Port — For a direct connection, e.g. 5432 PostgreSQL, 1433 SQL Server, 30015 HANA, 636 LDAPS. |
direct_protocol | text | No | Protocol — 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_name | text | No | Server name — Only when the certificate names a different host from the one connected to (SNI and verification). |
tls_min_version | text | No | Lowest TLS version — TLS 1.2 is the floor; nothing older can be chosen. Allowed: TLSv1.2 TLSv1.3 |
ca_certificate_id | uuid | No | Trusted CA — For a server whose certificate is issued by your own CA. Empty = the public roots. |
client_certificate_id | uuid | No | Client certificate — Presented to the server (mutual TLS). Needs its private key stored. |
pin_sha256 | text | No | Pinned 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
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Connection code |
name | text | Yes | Name |
connector_id | uuid | Yes | Connector |
environment | text | No | Environment |
base_url | text | No | Endpoint URL — HTTPS only (TLS 1.2 or higher), in every environment. For a https connection. |
username | text | No | Username — Basic authentication only. |
config | jsonb | No | Configuration |
status | text | No | Status |
owner_id | uuid | No | Owner |
transport | text | No | Transport — 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 |
host | text | No | Host — For a direct connection: the name or address only, e.g. hana.corp.local or 10.20.0.15. |
port | integer | No | Port — For a direct connection, e.g. 5432 PostgreSQL, 1433 SQL Server, 30015 HANA, 636 LDAPS. |
direct_protocol | text | No | Protocol — 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_name | text | No | Server name — Only when the certificate names a different host from the one connected to (SNI and verification). |
tls_min_version | text | No | Lowest TLS version — TLS 1.2 is the floor; nothing older can be chosen. Allowed: TLSv1.2 TLSv1.3 |
ca_certificate_id | uuid | No | Trusted CA — For a server whose certificate is issued by your own CA. Empty = the public roots. |
client_certificate_id | uuid | No | Client certificate — Presented to the server (mutual TLS). Needs its private key stored. |
pin_sha256 | text | No | Pinned 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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
portResponse
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
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
code | text | read, write | Connection code |
name | text | read, write | Name |
connector_id | uuid | read, write | Connector |
environment | text | read, write | Environment |
base_url | text | read, write | Endpoint URL — HTTPS only (TLS 1.2 or higher), in every environment. For a https connection. |
username | text | read, write | Username — Basic authentication only. |
secret_cipher | bytea | read only | Secret cipher |
secret_last4 | text | read only | Secret last4 |
config | jsonb | read, write | Configuration |
status | text | read, write | Status |
last_tested_at | timestamp with time zone | read only | Last tested at |
last_test_ok | boolean | read only | Last test ok |
last_test_message | text | read only | Last test message |
owner_id | uuid | read, write | Owner |
created_at | timestamp with time zone | read only | Created at |
transport | text | read, write | Transport — 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 |
host | text | read, write | Host — For a direct connection: the name or address only, e.g. hana.corp.local or 10.20.0.15. |
port | integer | read, write | Port — For a direct connection, e.g. 5432 PostgreSQL, 1433 SQL Server, 30015 HANA, 636 LDAPS. |
direct_protocol | text | read, write | Protocol — 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_name | text | read, write | Server name — Only when the certificate names a different host from the one connected to (SNI and verification). |
tls_min_version | text | read, write | Lowest TLS version — TLS 1.2 is the floor; nothing older can be chosen. Allowed: TLSv1.2 TLSv1.3 |
ca_certificate_id | uuid | read, write | Trusted CA — For a server whose certificate is issued by your own CA. Empty = the public roots. |
client_certificate_id | uuid | read, write | Client certificate — Presented to the server (mutual TLS). Needs its private key stored. |
pin_sha256 | text | read, write | Pinned fingerprint — Optional. The server certificate’s SHA-256 fingerprint; any other certificate is refused. |
last_handshake | jsonb | read only | Last handshake |
direct_reachable | boolean | read only | Direct reachable |
direct_checked_at | timestamp with time zone | read only | Direct checked at |
direct_probe | jsonb | read only | Direct probe |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
exception_override | jsonb | read only | Exception override |
credential_kind | text | read only | Credential kind |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › Connections for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.