Zid Guide

Setting up the Zid Integration

To access your users' data from Zid, you need to enable the Zid integration in the Platforms Page of the Rutter dashboard.

Zid uses OAuth 2.0 for authentication. You must create a developer app in the Zid developer portal to obtain a client ID and client secret, which are required to configure the integration on the Rutter dashboard. Refer to the Zid authorization documentation for details.

User Authentication with Zid

A Rutter Connection is created when your end user authenticates their Zid store via Rutter Link. This in turn allows you to access their account data via the Rutter API.

The user connects their Zid store through an OAuth 2.0 redirect flow:

Step 1: Log in to Zid.

The user must be logged in to their Zid account before connecting. Rutter Link provides a direct link to the Zid login page for convenience.

Step 2: Authorize Rutter.

Once logged in, the user clicks the button in Rutter Link to initiate the OAuth flow. They are redirected to oauth.zid.sa/oauth/authorize to grant Rutter access to their store.

Step 3: Connection is established.

After the user approves the authorization, Rutter exchanges the authorization code for an access token and the Rutter Connection is created.