Connect your own system or a private app to your Zid store
When no app in the App market does what you need, a developer can connect your store to a system you already use, such as an ERP, accounting or CRM system, or build an app made only for your store. This private app isn't published in the App Market: Zid makes it available to your store alone.
Zid's API can connect to any outside system that allows it, usually through a REST API. For example:
ERP systems, such as Odoo, Microsoft Dynamics, SAP and ERPNext.
CRM systems, such as HubSpot and Zoho.
Who does what
| Who | Responsibilities |
|---|---|
| Zid | Provides the API and its documentation, and technical support for developers through the Zid Partner portal. |
| You | Decide what the connection must do, hire the developer or the system's provider, and give them the access they need. |
| Your developer | Creates the private app, builds the connection, matches your store's data to the other system, and contacts Zid's partner support when needed. |
Zid doesn't build the connection for you: the developer you hire does, so agree with them on the requirements and on who supports the connection after it goes live.
Connecting to your store through Zid's API needs a plan that includes Zid API integration, which the plans comparison shows on the Professional plan and above. On a lower plan, you can buy the direct API integration service as an add-on from Billing > Browse add-ons; see Buy add-ons. Check your plan before you hire a developer.
For a shipping app, 1 riyal per order may be deducted from your wallet, as agreed.
What to look for in a developer
Choose a developer, or a provider, with hands-on experience in:
A backend programming language, such as Node.js, Python, PHP, C# or Java.
Building and using REST APIs, and reading JSON data.
Authentication with OAuth, and receiving live updates from your store through webhooks.
Connecting systems and mapping data between them.
Testing API requests with tools such as Postman.
Connect your system
List what the connection must do, such as syncing orders, products or stock between your store and your system.
Hire a developer, or ask your system's provider, and agree on support after launch.
The developer registers in the Zid Partner portal and creates a private app. Get a custom app, under Suggestions and private applications on the App Market page, opens the same portal.
The developer builds the connection with Zid's API, documented at docs.zid.sa.
When the app is ready, the developer doesn't send it for App Market review. Instead, they ask Zid's partner support, from the portal, to make the app available to your store. Partner support checks that your store meets the requirements, including the plan.
Once Zid adds the app to your store, activate it from My apps, or follow your developer's instructions. Before you activate it, review the data it can access, as for any app. See App details and installation.
Help for your developer
docs.zid.sa: the full API documentation.
help-partner.zid.sa: the partner help center, with guides to creating a private app.
bridge.zid.dev: a tool that gets the authorization tokens for a private app without coding, once the app is created.
Partner support, at partner.zid.sa/help-support: for technical problems. Ask your developer to describe the problem and include the API requests they used, so support can help faster.
Connect a service with a manager token
Some services connect with your store ID and a manager token instead of an app. You copy both from Settings > API integrations. See API integrations.
Related
Still need help?
Our customer service team is ready to help, or find quick answers in the FAQ.