# DZBuild API reference (English) > Reference for the DZBuild REST API v1: authentication, resources, webhooks and errors. Every link is the Markdown version of a page. All sections: https://dzbuild.com/llms-docs.txt ## General - [Authentication](https://dzbuild.com/api-docs/authentication.md): Learn how to authenticate API requests with platform keys and public keys, including Bearer tokens and HMAC signatures for secure DZBuild API access. - [Changelog](https://dzbuild.com/api-docs/changelog.md): The API is in pilot. Personal API keys must belong to a store on an active Enterprise plan, or every call returns 403; installed-app tokens work on every plan. https://api.dzbuild.app is the only supported host. - [Errors](https://dzbuild.com/api-docs/errors.md): Complete reference for DZBuild API error codes, HTTP status codes, error response format, and how to handle API errors in your integration. - [Idempotency](https://dzbuild.com/api-docs/idempotency.md): Every POST, PATCH, and DELETE requires an Idempotency-Key header. PUT accepts the header too: with a key it follows the rules on this page, and without one the request runs every time it is sent. - [DZBuild API](https://dzbuild.com/api-docs/intro.md): Build on DZBuild — full REST API for stores, products, orders, customers, landing pages, signups, and webhooks. - [Pagination](https://dzbuild.com/api-docs/pagination.md): Learn how DZBuild API uses cursor-based pagination for list endpoints. Efficient data fetching with next_cursor and has_more parameters. - [DZBuild POS](https://dzbuild.com/api-docs/pos.md): How the free DZBuild POS Windows till links to a store, and the calls it makes for products, photos, stock, sales documents, orders, customers and the events feed. - [Rate limits](https://dzbuild.com/api-docs/rate-limits.md): DZBuild API rate limits explained — Enterprise-only access, the per-store per-minute cap, expensive-endpoint budgets, and why these limits never affect your storefront or dashboard. ## guides - [Agent discovery](https://dzbuild.com/api-docs/guides/agent-discovery.md): Where AI agents and assistants find the DZBuild machine files, the MCP connector, the REST API description and every store catalog, and the rules they follow. - [Custom themes & storefronts](https://dzbuild.com/api-docs/guides/custom-storefronts.md): Build a fully custom storefront in React, Vue, Next.js, Flutter, or any stack — backed by DZBuild's API. - [Environment & .env setup](https://dzbuild.com/api-docs/guides/env-setup.md): How to safely store DZBuild API credentials in your application — from .env files to KMS to GitHub Secrets. - [For resellers](https://dzbuild.com/api-docs/guides/resellers.md): How to use the DZBuild API to resell stores, manage clients at scale, and integrate with your own back-office. ## public-key - [POST /v1/events](https://dzbuild.com/api-docs/public-key/events.md): POST /v1/events — generic merchant-tracked events (page views, leads, custom analytics). Same HMAC scheme as signups, no email/phone dedup. - [POST /v1/signups](https://dzbuild.com/api-docs/public-key/signups.md): POST /v1/signups — count an end-user signup against your monthly quota. The headline metered unit. HMAC-signed, accepted asynchronously, deduplicated by nonce + email. ## resources - [Analytics](https://dzbuild.com/api-docs/resources/analytics.md): Read a store's dashboard figures for a period with GET /v1/analytics: orders, revenue, profit, visitors and conversion, their change, and the chart series. - [Categories](https://dzbuild.com/api-docs/resources/categories.md): List, read, create, rename, move, delete and reorder the product categories of a store from your own code, then undo a rename, a move or a delete. - [Changes and undo](https://dzbuild.com/api-docs/resources/changes.md): List the configuration changes made through the API, read one with the values it replaced, and undo it to put those values back on the store. - [Customers](https://dzbuild.com/api-docs/resources/customers.md): Read your customer list, look up by phone or email, view all orders for a customer. - [Home page sections](https://dzbuild.com/api-docs/resources/home-layout.md): Read and change the sections of a store's home page from your own code, with ten section types, then add, update, hide, reorder, delete, replace or undo. - [Keys (your own keys)](https://dzbuild.com/api-docs/resources/keys.md): Mint, list, and revoke API keys for your store. Both platform (Bearer) and public (HMAC) keys. - [Landing pages](https://dzbuild.com/api-docs/resources/landing-pages.md): CRUD for landing pages — single-product conversion pages with sections (image carousels, order forms, fake visitors, countdowns, special offers). - [Store menus](https://dzbuild.com/api-docs/resources/menus.md): Read and replace the navbar and footer links of a store from your own code as one document, with a version check, then undo a change or reset. - [Orders](https://dzbuild.com/api-docs/resources/orders.md): Create, read, transition, and cancel orders. Full variants support, multi-line carts, server-authoritative pricing. - [Store pages](https://dzbuild.com/api-docs/resources/pages.md): List, read, create, change and delete the Markdown pages of a store from your own code, such as About us or Returns, then undo a change or a delete. - [Tracking pixels](https://dzbuild.com/api-docs/resources/pixels.md): List, add, update and delete a store's tracking pixels for Meta, TikTok, Snapchat, Pinterest and Google from your code. Access tokens are write-only. - [Products](https://dzbuild.com/api-docs/resources/products.md): Full CRUD for the product catalog — list, get, create, update, delete. With variants, images, plan limits. - [Promo codes](https://dzbuild.com/api-docs/resources/promo-codes.md): List, create, update and delete a store's promo codes from your own code, with the add-on rule, the 100% discount confirmation and undo. - [Quotas](https://dzbuild.com/api-docs/resources/quotas.md): See the Enterprise tier limits, any per-store overrides set by support, and your effective limits. - [Shipping](https://dzbuild.com/api-docs/resources/shipping.md): Read and set delivery prices per wilaya and the free-shipping rules, link, test and sync couriers, check courier coverage, and list wilayas and communes. - [Store](https://dzbuild.com/api-docs/resources/store.md): GET /v1/store — your store's profile (name, slug, theme, custom domain, public URL). - [Themes](https://dzbuild.com/api-docs/resources/themes.md): List the storefront themes, fast-checkout form themes and variant picker styles a store can use, then switch each of them from your own code. - [Usage](https://dzbuild.com/api-docs/resources/usage.md): View your month-to-date API usage and historical hourly rollups. - [WhatsApp messages](https://dzbuild.com/api-docs/resources/whatsapp.md): Read the WhatsApp order templates, the store's WhatsApp wallet and message log, and send a template to an order's buyer from your own code. ## webhooks - [Event catalog](https://dzbuild.com/api-docs/webhooks/events.md): Every webhook event DZBuild can fire, with the exact shape of its payload data field. - [Webhooks](https://dzbuild.com/api-docs/webhooks/overview.md): How DZBuild webhooks work — what events fire, how delivery + retries behave, security guarantees, and what your endpoint must do. - [Registering a webhook](https://dzbuild.com/api-docs/webhooks/registering.md): Create, list, test, and delete webhook subscriptions for your store. - [Verifying signatures](https://dzbuild.com/api-docs/webhooks/verifying-signatures.md): How to authenticate inbound DZBuild webhooks. Constant-time HMAC comparison + freshness check, with copy-paste code in Node.js, PHP, Python, and Go.