Sign in Start free trial
Help centre › Modules

Connector (API and Website CMS)

Let other apps, websites and mobile apps read and write your EZI ERP data safely through API keys, and manage your website content.

What it is

The Connector module opens a safe door into your EZI ERP data for other software. A mobile app, your online shop, or a developer's custom tool can use it. This door is called an API. Each program that uses it gets its own client: a name, an ID and a secret key. The program uses these to sign in.

For a business, the Connector menu can also include Website CMS. There you edit the content of a website linked to your business.

Why you would use it

  • Connect a mobile app or a website so orders and customers flow into the ERP with no retyping.
  • Let a developer build reports or tools on your live data without giving them your password.
  • Shut off one connection at any time without touching the others.

How to use it

Open Connector in the left menu. A business user sees:

  • Website CMS, if your account allows it
  • API Clients & Keys
  • API Documentation

Create an API client (a key for one app)

  1. Go to Connector > API Clients & Keys.
  2. Click Create Client.
  3. Enter a Name that says what the key is for, for example "Shop website" or "Delivery app". Click Save.
  4. The new client shows in the list with its ID and Client secret. Give these two values, plus a staff user's login, to your developer. The app signs in with them.
  5. To cut off an app, click Delete next to its client. That app stops working at once.

Read the documentation

Go to Connector > API Documentation. This page lists everything the API can do. Your developer will need it. The API can:

  • read business locations, products, variations, brands, categories, units, taxes, selling price groups, tables, types of service and users
  • read, create and update contacts, and record contact payments
  • list, create, update and delete sales, and record sell returns and shipping status
  • list, create and update expenses and cash registers
  • read profit/loss, product stock, notifications, payment accounts and payment methods
  • record attendance clock-in and clock-out (with the HRM module)

Website CMS

Connector > Website CMS lets you manage your website's Settings, Articles, Projects and Leads. Leads are the enquiries people send from the website. You can change a lead's status as you follow it up.

Tips / common questions

  • Treat the client secret like a password. Do not post it in chats or emails that many people can read.
  • Make one client per app. Then you can turn one off without breaking the rest.
  • The app works with the permissions of the user it signs in as. Give that user a role with only what the app needs. See Roles and permissions and Users.
  • If the Connector menu is missing, your package may not include the Connector module. Ask your administrator.
  • Platform administrators also see Website Manager, Website Designers, Clients and Documentation. The Regenerate button, which rebuilds the API keys and documentation, is for administrators only.