Create an API key and make a first read

Confirm access with a read before integrating a product using its current OpenAPI.

Open the workspace

Instructions reviewed

Current workspace availability, quotes and permissions apply. The review date is not a live provider status. Reading help makes no checks or payments.

Before you start

  • Sign in to a verified merchant. Store the key privately on your server, not in frontend code or Git.

Follow these steps

  1. In API Keys, choose a name and read or read/write access. Create and save the key once. If lost, revoke and replace it.

    You should see： The list shows name, prefix and access, not a permanently visible full key.

  2. Use the read-only example below for /console/api/capabilities with Authorization: Bearer and your GridZen key.

    You should see： Your capabilities return. HTTP 200 does not enable every live product.

  3. Read the current merchant OpenAPI for the target schema, permissions, quote and idempotency fields. Keep ID and payload unchanged when retrying the same uncertain task.

    You should see： You can identify sandbox versus live and the original-result lookup.

read -rsp 'GridZen API Key: ' GRIDZEN_API_KEY; echo
export GRIDZEN_API_KEY
curl --fail-with-body https://gridzen.ai/console/api/capabilities \
  -H "Authorization: Bearer $GRIDZEN_API_KEY"
unset GRIDZEN_API_KEY

OpenAPI JSON

Completion check

The read succeeds without exposing the key. Live writes still require product authorization.

If you get stuck

  • 401: check key and Bearer syntax. 403: check access and eligibility. 429: respect the limit.

Next steps and related guides

Unclear step? Report its location

Include the guide, step, visible message and expected outcome. Redact screenshots. Do not include codes, keys, identity documents, full accounts or customer records.

open@gridzen.ai