Onboarding Flow

To establish a connection and retrieve data from your customer's ERP System, you must invite them to use the Onboarding Flow.

Embedding the Onboarding Flow

We recommend that you embed the Onboarding Flow in an iframe, so that you can control the look and feel of the size and also the area outside of the iframe in whatever way you wish.

One-time code

You must use a one-time code together with the onboarding link, to enable your Customer to load the Onboarding Flow successfully.

📘

Note

One time codes are valid for one hour from creation.

---

Ways to onboard your Customer

You can use the Onboarding Flow to onboard your Customer in several ways.

Let them choose their ERP System

If you wish to give your Customer a choice when selecting their ERP System, we have developed a screen that allows them to choose any of the ERP System that we support today.

ERP system selection is located at: https://onboarding.zwapgrid.com/consent/<Consent ID>/=?otc=<One Time Code>

Direct link to a specific ERP System

If you wish to direct your customer to a specific ERP System or develop a screen to begin the onboarding from within your own platform, you can deep link directly to the onboarding flow for that system.

Deep linking is located at: <https://onboarding.zwapgrid.com/consent/<Consent ID>/<ERP System>/?otc=<One Time Code>

You should replace Consent ID and ERP System in the url with the correct values (you can see a list of available ERP system IDs in the table below)

Redirect back to your platform

If you wish to let your Customer return to your platform at the end of the onboarding, you can do so by including the query parameter redirectURL in the URL.

e.g: https://onboarding.zwapgrid.com/consent/<Consent ID>/??otc=<One Time Code>&redirectUrl=http://www.google.com