Developers
Build on Route Royal
The SDK, the API, webhooks, OAuth apps and the MCP server, for your own sites, apps and agents. The developer tools are in the portal, open to organisations we have given developer access.
A developer with access
- Signed inYour Route Royal account
- Your organisationAccess belongs to it
- Your roleAllowed to manage developer settings
- Developer accessGranted to your organisation
- Developer portalAuthorised
Every check passed: the keys, apps and webhooks are yours to manage.
What you build with
Five ways in
Each one works within your organisation’s data and the permissions you grant.
Next.js SDK
Typed hooks for the browser and clients for the server: sign-in, listings, bookings, enquiries, posts, commerce and analytics for headless sites. This site runs on it.
REST API
Read and write your organisation’s data at api.routeroyal.com, with keys scoped to what each integration needs.
Webhooks
Events for contacts, deals, properties, products, orders, payments and more, signed with HMAC-SHA256 so you can check they came from us.
OAuth apps
Let people sign in with Route Royal and act for them through OAuth 2.0: authorisation codes, tokens and revocation.
MCP server
Give your own agents Route Royal’s tools over the Model Context Protocol, within the permissions you grant.
Getting access
From request to live keys
- 1
Ask for access
Tell us what you are building, and for which organisation.
- 2
We switch it on
We turn developer access on for your organisation, on terms we agree with you.
- 3
Create your keys
Sign in, register your domain, verify it by DNS and create a publishable and a secret key.
- 4
Go live
Build with test keys, then switch to live ones when you launch.
Keys
Two keys, kept apart
Every SDK key belongs to a domain you have verified. The full key is shown once, and we keep only its hash.
- Publishable keys (pk_) only read, so they are safe in the browser.
- Secret keys (sk_) can write, so they stay on your server.
- Each key is tied to a verified domain, and can carry an expiry date and an IP allowlist.
- Requests are rate limited, so no one integration crowds out the rest.
NEXT_PUBLIC_ROUTEROYAL_DOMAIN=www.example.com
NEXT_PUBLIC_ROUTEROYAL_PUBLIC_KEY=pk_test_…
# Server only: never in browser code
ROUTEROYAL_SECRET_KEY=sk_test_…Questions
What developers ask
Who can get developer access?
Organisations on Route Royal. We grant it per organisation, and within it, the people whose role lets them manage developer settings can use it.
Does developer access cost extra?
We agree terms with each organisation when we grant access. Ask us, and we will tell you what applies to what you are building.
Where is the documentation?
It comes with access. The SDK is a private package with its guide included, and we walk each new integration through with the team building it.
Do I need developer access to use Claude or ChatGPT with Route Royal?
No. Connecting Claude or ChatGPT to your organisation is part of AI and Q. Developer access is for building your own sites, apps and agents.
Are there rate limits?
Yes. Every key and token is rate limited, and AI agents have their own limits per minute and per session. We tell you the limits that apply when we grant access.
Is anything built on it today?
This website. Its news is Route Royal posts read through the SDK, the same way your site would read your listings, bookings or posts.
Developer access
Make your first call to Route Royal
Developer access is granted per organisation. Tell us what you are building and for which organisation. Once it is switched on, you create your keys in the portal and make this call with your own.
Requests go by email to support@routeroyal.com.