Getting Started
10-20 minute pathUse this checklist to go from a new Quardlyn developer account to sending your first sandbox property without internal help.
Goal: create a sandbox application, copy the sandbox credentials, send a canonical property, test lifecycle changes, inspect sandbox webhook simulations, then run certification before requesting production access.
1. Create Developer AccountRegister, verify your email, then open the Developer Console.
2. Create Sandbox ApplicationGo to Applications and create a sandbox application.
3. Copy Sandbox API Key and SecretSave the one-time API key and signing secret shown after creation.
5. Read Canonical Property SchemaReview required fields and media fields in the Canonical Schema.
6. Create Your First PropertySend
POST /api/v1/sandbox/crm/properties or use the API Explorer.7. Inspect Sandbox Webhook SimulationsUse your sandbox application webhook simulation logs and inspect simulated events in Webhook Logs.
8. Test Updates and DeletionsRun
PUT, PATCH, withdraw, restore and DELETE flows.9. Run Certification ChecklistUse the Certification Guide and the downloadable integration checklist.
10. Request Production AccessAfter sandbox certification passes, contact Quardlyn with your report and request production credentials.
First Property in Postman
Endpoint
POST {{base_url}}/api/v1/sandbox/crm/propertiesThe Postman collection signs requests automatically when sandbox_key and sandbox_secret are set.
Minimal Payload
{
"request_id": "getting-started-001",
"property": {
"external_ref": "CRM-GS-001",
"department": "sale",
"display_address": "10 Sandbox Street, London",
"postcode": "SW1A 1AA",
"price": 425000,
"bedrooms": 3,
"media_image_00": "https://example.com/property/front.jpg"
}
}| What to check | Where |
|---|---|
| Request accepted and returns success | Postman response body or API Explorer response. |
| Property stored in sandbox | Developer Console / Sandbox |
| API request logged | Developer Console / API Logs |
| Sandbox webhook simulation visible | Developer Console / Webhook Logs |
| Usage counter updated | Developer Console / Usage |
Before Inviting CRM Vendors
Recommended dry runRun one real integration yourself using only the public documentation, Postman collection and sandbox credentials. Do not rely on internal shortcuts.
Integration Journey
- Create a property.
- Update it.
- Upload images.
- Withdraw it.
- Delete it.
- Inspect sandbox webhook simulations.
Confidence Gate
If this journey can be completed from public docs alone, external CRM developers should have enough context to start integrating with Quardlyn.
Open Certification