EYalla Developer Documentation
Welcome. This site is for developers integrating with the EYalla platform — building custom themes, listening for webhooks, calling our APIs, or authoring extension packages.
If you're a store owner looking for the user guide, please log into /admin and click User Guide under the Help menu.
Quick links
- Merchant API — read orders, products, and customers; update fulfilment; create products. Elite plan.
- Access Control API — let card readers, turnstiles and face terminals check a studio's members at the door, and read its member list. For studios with the Access Control add-on.
- Webhooks — listen for order, payment, shipping, and tenant lifecycle events.
- Authentication — how API tokens work.
- Custom themes — author Composer-package storefront themes that tenants can install.
- Template package authoring — build a new vertical template (gym / restaurant / boutique) and ship it as a Composer package.
- Changelog — breaking changes, deprecations, schema migrations.
Get started
- Get an API key from the store you're integrating with. Its owner creates one in their admin under Settings → API keys (
/admin/api-keys), chooses the scopes, and sends it to you. The key is shown once and stored hashed, so it cannot be recovered later — if it is lost, the owner issues a new one. Requires the Elite plan. - Read Authentication for the base URL, the scope names, and the error shapes.
- Call the API at
https://api.eyalla.net/v1— the key identifies the store, so no subdomain or tenant id appears in the URL. - Pick an integration surface and dive in.
No developer accounts or sandbox tenants yet. An earlier version of this page invited you to sign up for a developer account and offered a sandbox tenant at
<your-name>.sandbox.eyalla.com. Neither exists — there is no developer-account signup, and that hostname does not resolve. Today a tenant API key from a live store is the only credential, so test against a store whose owner has agreed to it. Questions: developers@eyalla.com.
Support
- Email:
developers@eyalla.com - Issues: GitHub repository (link sent on developer account approval)
- Office hours: every other Thursday, 4–5pm KW time, on Zoom
License + terms
Code samples on this site are MIT-licensed. Authored themes and template packages must be licensed compatibly. Full terms in your developer account onboarding email.