মূল কনটেন্টে যান
১৪ দিনের ফ্রি ট্রায়াল, কার্ড লাগবে না৯টি ভাষা১৭৬টি ব্যবসার ধরন · ৫০টি অ্যাপ
BN· USD
লাইভ ডেমো চালিয়ে দেখুনফ্রি ট্রায়াল শুরু করুন

এই পেজটি এখনো বাংলা ভাষায় পাওয়া যায় না, তাই ইংরেজিতে দেখানো হচ্ছে।

Set up a workspace or a development install

API and webhook work needs a workspace and a key; plugin work needs your own install of the code, where you are super admin.

  • about 8 min

For API and webhook integrations

  1. Use a zmle workspace where you are an admin (a trial workspace is fine).

  2. Open Admin → Settings → Integrations & API (/admin/integrations, permission settings.integrations).

  3. Create an API key: a name, the scopes you need, an optional expiry. Copy the key — it is shown once; only its SHA-256 hash is stored.

  4. Put it in an environment variable on your machine, never in source code.

  5. Call GET /api/v1/me to see which key you are and which scopes it has.

Check your key
export ZMLE_BASE="https://your-workspace.zmle.com/api/v1"
export ZMLE_KEY="fx_live_..."        # paste your key; never commit it

curl -s "$ZMLE_BASE/me" -H "Authorization: Bearer $ZMLE_KEY"
In a demo sandbox workspace webhook deliveries are simulated — nothing is sent to your URL. Use a real (trial) workspace to receive webhooks.

For plugins, widgets and core changes

Plugins are installed for a whole server, so you develop them on your own single-company install of the code, where you are super admin. The install guide covers Docker, a VPS, Windows Server and shared hosting.

Run a development install
# Node 20+, PostgreSQL 15+ (or MySQL 8 / MariaDB 10.6+)
unzip <release>.zip -d app && cd app
node start.mjs            # first start installs dependencies, then open http://localhost:3000/install

# or with Docker (PostgreSQL 17 + the app)
docker compose up -d
  • Plugin folders live under modules/<id>/; the reference plugin is modules/example-checklist/ and the manifest template is modules/_templates/module.json.
  • Install, update and Module Studio writes need a super admin; ALLOW_SELF_UPDATE=0 locks the build pipeline (use it in production, not on your dev install).
  • Run npm run plugin:check <id> to validate a manifest and run the plugin's own test file.

Written from: docs/API.md, docs/INSTALL.md, docs/PLUGINS.md, modules/_templates/module.json, src/lib/integrations/webhooks.ts