Developer API

The Guidez developer API lets a creator’s website show their maps and report how they sell. Your server calls it with an API key. It returns a preview of each map (title, description, cover image, price, landing page link) and each map’s sales over time.

It is read-only. To sell a map on the website, keep using the embed from the Website integration tab.

Get an API key

1. The creator invites you from Website integration in their Creator Portal, or works on it themselves.
2. Sign in to web.guidez.app and open Developer API in the portal.
3. Enter a name for the key, such as Production website, and select Create key.
4. Copy the key. It starts with gz_live_ and is shown only once.
5. Save it as a secret on your server, for example an environment variable named GUIDEZ_API_KEY.

The Developer API tab with a newly created key and the key list/screenshots/developer-api-keys.png

Make your first request

curl https://api.guidez.app/developer-api/v1/maps \
  -H "Authorization: Bearer $GUIDEZ_API_KEY"

You get the creator’s published maps. Every endpoint is in the API reference.

Keep the key safe

• Server only. Never put the key in browser code, a mobile app, or a repository. Browsers are blocked from calling the API, and anyone holding the key can read the creator’s maps and sales.
• Rotate without downtime. Create a new key, deploy it, then select Revoke on the old one. Both work until you revoke.
• Lost a key? Guidez does not keep a readable copy, so it cannot be shown again. Create a new one and revoke the old one.
• Access ends with the invite. When the creator removes you, every key you created stops working.

Limits

• Up to 120 requests a minute per key. Past that you get 429 with a Retry-After header.
• Up to 10 active keys per creator.
• Cache responses for a few minutes rather than calling the API on every page view.