Changelog
Changes to the API, SDKs and MCP server. Current version of the specification: 1.0.0. What counts as compatible is described in versioning.
The API is built and tested. Hosting at api.garanify.com is in preparation; until then it runs locally. Keys are available on request.
-
1.0.0· in preparation, not publicly available yet
First version: shops, keys, products (including bulk upserts), rules, resolution with a reason, rendering of notice and GARAN label, public endpoint for the snippet, webhooks.
- Changed before the release:
lastDeliveryon the webhook endpoint is now{ at, ok, outcome }instead of an HTTP status.outcomeisdelivered,rejectedorunreachable. - Webhooks: list deliveries of the last 30 days, redeliver, test event
webhook.test, catalogueGET /v1/webhook-events, headerGaranify-Webhook-Id. - Webhooks only go to public addresses; redirects are not followed.
- Test mode: test shops with
gfy_sk_test_…andgfy_pk_test_…, every feature without a licence, fieldlivemodeon shop,/v1/meand events. New errorlive_key_required(403) when linking licences. - Every response carries
Request-Id; errors containrequestId. Idempotency-Keyalso for creating shops, creating keys and rotating keys.- New error
account_shop_limit(409) when an account has reached its maximum number of shops. 429withRateLimit-*andRetry-Afteris documented on every endpoint.- CORS for test secret keys, so that “Try it” in the docs works. Live secret keys still get no CORS.
- SDKs
@garanify/sdk(Node.js) andgaranify/sdk(PHP) and the MCP server@garanify/mcpat version 0.1.0, not published yet.
- Changed before the release:
Changes to the plugins and the website are in the main changelog. The specification: openapi.yaml.