Platform
Integrations and API: REST, webhooks, WhatsApp and imports
Integrations in ArkanERP are the ways the system connects to what is around it: a REST API your other system reads and writes with a user's key and permissions, webhooks that send a document to your address the moment it is saved or submitted, WhatsApp Business for messaging customers from the system, ZATCA's Fatoora platform, payment gateways and email, and data imports from Excel. All of them run with the user's own permissions, so an integration reaches no more than the key's owner can.
- A REST API with a key and secret per user
- Webhooks on save, submit or cancel
- WhatsApp Business with approved templates
- Excel imports that read old systems' files
What Integrations and API does
A REST API
Every screen in the system has a JSON API: read, create and update documents and call the allowed operations. An integration signs in with a key and secret generated for a user, or through OAuth 2, and works with that user's permissions and cost centers alone.
Webhooks on every event
When a document is saved, submitted, cancelled or deleted, the system sends its data to an address you set, as JSON or a form, with headers you choose and an optional condition, signed with a secret the receiver checks the request against.
WhatsApp Business
A link with Meta's WhatsApp Business Cloud API: receive customers' messages, send text, media and approved templates and follow their status (sent, delivered, read), bulk messages, and a WhatsApp notice on a document event with its print attached as a PDF, such as an invoice when submitted. It shows in the CRM as well.
Payment gateways
The payments app connects gateways such as Stripe, PayPal, Braintree, Razorpay and GoCardless: the customer gets a payment request with a link, and the payment is recorded once made. The online store pays through it.
Company email
The company's mailbox, Gmail, Outlook, Hostinger or any IMAP and SMTP server, for sending and receiving, with email templates and the sent log and queue. Until the company's account is added, mail goes out from the platform's mailbox and the administrator is told so.
ZATCA
A direct link with the Fatoora platform to clear tax invoices and report simplified ones, with signing, the QR code and each invoice's status and rejection reason followed.
Import any data
The import tool inserts new records or updates existing ones on any screen from Excel, CSV or a Google Sheets link, with a downloadable template. Its «Fix issues» step matches what the file names to what the system holds, such as an item group by its number or its name in any spelling. Old systems' exports saved as text under an xls name, in the Arabic Windows code page, are read as they are.
Ready importers for moving over
Customers' and suppliers' opening balances, opening stock into one warehouse or several, item prices for several price lists at once, employees, the lines of multi-line vouchers and entries by account and cost center numbers, product cards, tailoring measurements and rental contracts.
Telephony and attendance devices
The telephony app connects Twilio and Exotel for calls and their log from customer screens, and attendance devices have an endpoint to send check-ins by employee number.
How the work flows
- 1
Decide the link
Decide what is read from the system, what is written to it, and which events the other system must hear of.
- 2
The integration user
Create a user with only the permissions it needs, and generate its key and secret.
- 3
Set up
Set the event webhooks, or the WhatsApp account and templates, the payment gateway or the mailbox.
- 4
Follow-up
Read the WhatsApp, email and error logs; any new API key shows in system monitoring.
Questions about Integrations and API
Does ArkanERP have an API?
Yes. A JSON REST API for every screen, entered with a user's key and secret or through OAuth 2, working with that user's permissions.
Can an outside web shop or delivery app be connected?
A developer can connect it through the API and webhooks; there are no ready-made connectors for particular platforms yet. To sell online with no connecting at all, there is the built-in online store.
Does the system send invoices on WhatsApp?
Yes. Once a WhatsApp Business account and a Meta-approved template are set, a message goes out when the invoice is submitted, with its print as a PDF.
How do I move my data from my old program?
Export from the old program to Excel and import with the import tool or the ready importers for balances, stock, prices and employees, even when the file is text saved under an xls name.
Is connecting safe?
An integration works with its user's permissions only, a key is revoked by generating another, webhook requests are signed with a secret, and every new API key is logged in system monitoring.
Systems that work with it
- ZATCA e-invoicingPhase 2 link with ZATCA's Fatoora: signed invoices with QR codes, clearance of tax invoices, reporting of simplified ones, branches, and every invoice tracked.
- Online storeAn Arabic web shop inside your ERP: items published from the item card with your price list and warehouse stock, and carts that become sales orders.
- Customer relations (CRM)Arabic CRM: leads and deals on a kanban board, tasks, notes and calls, email and WhatsApp from the record, and a won deal turned into a customer and quote.
- Cloud and data securityArkanERP in the cloud: a separate database per business, encrypted nightly backups off the server, admin sign-in codes, automatic attack blocking, restore.
- System monitoringA System health screen for admins: response speed, errors, background jobs, backups, ZATCA rejections and failed sign-ins, each with a button to its fix.
- General accountingArabic cloud accounting for Saudi firms: a numbered chart of accounts, cost centers and projects, vouchers, statements, trial balance and multi-currency.