Getting Started

Getting Started

Welcome to the DidYouGo API. This documentation covers the core flows for QR code address management, QR code tags, authentication, appointment import, service confirmations, and webhooks.

Credentials & Provisioning

Access to the DidYouGo API is provisioned out-of-band by the DidYouGo team. You will receive an API key and a matching secret. Every request must pass them as a Bearer token separated by a colon.

Authentication Authorization: Bearer <api_key>:<api_secret>

See the Authentication page for all supported methods.

Base URL

EnvironmentBase URL
This environmenthttp://staging.didyougo.com.au/api

Common Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
AuthorizationBearer <api_key>:<api_secret>Yes

First Integration Checklist

  1. Request API credentials (key + secret) from DidYouGo.
  2. Confirm which environment the credentials target.
  3. Verify authentication with a GET /api/qrcodes call.
  4. Create your first QR code address (example below).
  5. For imports, choose sync mode for small payloads or background mode for large ones.
  6. If you need push notifications, register a webhook (see Webhooks).
  7. Review Errors & Rate Limits to handle failures and throttling.

Quick Start: Create a QR Code Address

1. Verify authentication

curl
curl -H "Authorization: Bearer your_api_key:your_api_secret" \
  http://staging.didyougo.com.au/api/qrcodes?organization_uuid=org-uuid-here

2. Create a QR code address

curl
curl -X POST http://staging.didyougo.com.au/api/qrcodes \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_api_key:your_api_secret" \
  -d '{
    "location": "123 Main St, Sydney NSW 2000",
    "organization_uuid": "org-uuid-here",
    "type": "SITE",
    "name": "Main Office"
  }'

3. Verify it was created

curl
curl -H "Authorization: Bearer your_api_key:your_api_secret" \
  http://staging.didyougo.com.au/api/qrcodes?organization_uuid=org-uuid-here

Next Steps