The API
An API is a way for your developer, or another app, to read and add Ziira information without anyone using the screens. For example, showing your stock levels on your website.
- It is versioned, so what works today keeps working: new things are added, and anything removed is announced at least six months ahead.
- Each access key does exactly what you allow, for the whole business, one company or one branch. A key can be view-only, can expire, can be limited in how often it is used, and can be replaced without a gap.
- A key can only use the documented public parts of Ziira. If one leaks, it cannot reach your users, your settings or other keys.
- Safe to repeat: if a request is sent twice by mistake, it is only done once.
Today it covers products, customers, sales, invoices, stock levels, payments and alerts.
Webhooks
A webhook is an automatic message Ziira sends to another app the moment something happens, so the other app stays up to date without asking again and again.
- Only events that Ziira marks as shareable leave the system, and only with an exact list of fields. Names, phone numbers, emails and free text are left out on purpose.
- Each message is signed, so the receiver can check it really came from Ziira. It is sent after the transaction is saved, retried with growing waits if the receiver is down, and written to a log.
- The receiving address must be public and secure (HTTPS).
Events include sale posted, sale returned, invoice issued, goods received, payment received, stock below reorder level, alert created, customer created and product created.
Not covered yet
There is no sign-in on behalf of individual people yet. A key belongs to the business and is meant for one server talking to Ziira. Keep it in a safe place on that server, never in a web page or phone app.