Vai al contenuto
Garanify

API reference

Every endpoint of version 1, generated from the OpenAPI 3.1 file. Base URL https://api.garanify.com.

The API is built and tested. Hosting at api.garanify.com is in preparation; until then it runs locally. Keys are available on request.

Shops

A shop is one website with its domains, languages and display settings. Every key belongs to exactly one shop.

MethodPathDescriptionKey
GET /v1/me Inspect the current key Secret key, Publishable key
POST /v1/shops Create another shop Secret key
GET /v1/shops/{shop} Retrieve a shop Secret key
PATCH /v1/shops/{shop} Update a shop Secret key
GET /v1/shops/{shop}/license Retrieve the plan Secret key
PUT /v1/shops/{shop}/license Link a licence Secret key
DELETE /v1/shops/{shop}/license Unlink the licence Secret key
GET /v1/shops/{shop}/evidence Export evidence (CSV) Secret key

Keys

Secret keys (gfy_sk_…) for your server, publishable keys (gfy_pk_…) for the browser.

MethodPathDescriptionKey
GET /v1/shops/{shop}/keys List keys Secret key
POST /v1/shops/{shop}/keys Create a key Secret key
POST /v1/shops/{shop}/keys/{key}/rotate Rotate a key Secret key
DELETE /v1/shops/{shop}/keys/{key} Revoke a key Secret key

Products

Products with brand, model identifier and producer guarantee. Garanify never stores end-customer data.

MethodPathDescriptionKey
GET /v1/shops/{shop}/products List products Secret key
POST /v1/shops/{shop}/products/bulk Upsert up to 1000 products Secret key
GET /v1/shops/{shop}/products/{sku} Retrieve a product Secret key
PUT /v1/shops/{shop}/products/{sku} Create or replace a product Secret key
DELETE /v1/shops/{shop}/products/{sku} Delete a product Secret key

Rules

GARAN rules give all matching products a producer guarantee in years. Pro and Agency.

MethodPathDescriptionKey
GET /v1/shops/{shop}/rules List rules Secret key
PUT /v1/shops/{shop}/rules Replace all rules Secret key

Resolve

Which label applies to a product, and why.

MethodPathDescriptionKey
GET /v1/shops/{shop}/products/{sku}/resolve Resolve a stored product Secret key
POST /v1/shops/{shop}/resolve Resolve without saving Secret key

Render

The official notice and GARAN label as SVG, PNG or HTML fragment.

MethodPathDescriptionKey
GET /v1/shops/{shop}/products/{sku}/garan Render the label of a product Secret key, Publishable key
GET /v1/render/garan Render a GARAN label from values none
GET /v1/render/notice Render the notice none
GET /v1/assets/fonts/{file} Font file for HTML fragments none

Public

Read-only endpoints for the browser (embed snippet), authenticated with a publishable key.

MethodPathDescriptionKey
GET /v1/public/{shop} Display settings of a shop Publishable key
GET /v1/public/{shop}/products/{sku} Label of a product for the browser Publishable key

Webhooks

Signed notifications about invalid products and licence changes.

MethodPathDescriptionKey
GET /v1/shops/{shop}/webhook Retrieve the webhook endpoint Secret key
PUT /v1/shops/{shop}/webhook Set the webhook endpoint Secret key
DELETE /v1/shops/{shop}/webhook Delete the webhook endpoint Secret key
POST /v1/shops/{shop}/webhook/test Send a test event Secret key
GET /v1/shops/{shop}/webhook/deliveries List webhook deliveries Secret key
POST /v1/shops/{shop}/webhook/deliveries/{delivery}/retry Send a delivery again Secret key
GET /v1/webhook-events List event types none

Meta

Languages, modules and health.

MethodPathDescriptionKey
GET /health Health check none
GET /v1/languages List languages none
GET /v1/modules List modules none