Global Clinic ConnectGuides
Developer portal · integrate step by step

From first API key to a production-ready integration.

Choose a business capability, follow the complete workflow, copy working examples, handle errors confidently, and test supported APIs without leaving the guide.

Start integratingOpen API console
Public APIs onlySupported integration contracts
Business capabilitiesOrganized by what you want to achieve
Test as you learnInteractive requests with your API key
01

Follow the integration journey

Begin with credentials and a first request, then add the capabilities your product needs. Each guide includes purpose, authentication, workflow, examples, errors, and production practices.

01
Foundation

Getting started

Create a narrowly scoped API key, make a safe first request, and understand the response and rate-limit basics.

An authenticated test request from your server environment →
02
messages:send

Send patient messages

Send a transactional text or approved WhatsApp template while respecting consent, reply windows, and delivery state.

A message accepted into the workspace’s delivery flow →
03
conversations:read

Synchronize conversations

Read conversation summaries and messages for a connected inbox or workflow system.

A bounded, privacy-conscious conversation synchronization flow →
04
social

Publish social content

Create drafts, schedule posts, publish approved content, and track each network’s outcome.

A social publishing integration with per-network status tracking →
05
documents:write

Ingest documents

Create a document and upload its bytes through a short-lived, controlled upload form.

A partner upload that enters the normal document preparation flow →
06
Foundation

Errors, retries, and production readiness

Turn API responses into predictable retry, alerting, and support behavior.

An integration that fails safely and recovers without duplicate actions →
02

APIs by business capability

Only supported server-to-server APIs are included. Application-internal routes and implementation details are intentionally excluded.

1 endpoint

Messaging

Send text and approved templates

messages:send2 endpoints

Conversations

Synchronize conversations and delivery state

conversations:read3 endpoints

Social publishing

Draft, schedule, publish, and track posts

social1 endpoint

Document ingestion

Create controlled partner uploads

documents:write
03

Test a request

Use a synthetic test account and an API key from Settings → Developer. The key and response stay only in this browser tab.

Interactive console

Try a supported API

Requests go directly from this browser tab to the API environment you choose. Keys and responses are held in memory only and are cleared when the page closes.

Do not use real patient data in tests
POST/api/public/v1/messages
Response
Ready when you are

Enter a test key, review the sample request, and send it. The response will appear here.

Equivalent cURL example
curl -X POST 'https://api.connect.globalclinic.app/api/public/v1/messages' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data '{
  "to": "+15551230000",
  "type": "template",
  "kind": "transactional",
  "template": {
    "template_id": "appointment_confirmation",
    "variables": { "name": "Sample Patient", "time": "10:30 AM" }
  },
  "idempotency_key": "9ac86af7-43f5-4b5d-a1e2-2b57a0743324"
}'
Required scopemessages:send

Queue a WhatsApp text or approved template message for a recipient.