Introduction

This document describes the various screens and pages for the Aggregator solutions on RMS UI.

Clickpost Config

In this screen, you can add the clickpost credentials to be used for generating shipping label
On clicking the “+” button, the add clickpost config window opens

Enter the form details here:
- Clickpost Username- Clickpost username to be used in the Clickpost API calls. You can get this from Clickpost team.
- Clickpost API Key- Clickpost API key to be used in the Clickpost API calls. You can get this from Clickpost team.
- Clickpost Webhook Key - The webhook which will be used by Clickpost to push notifications to RMS. To get this
  - Login to Client’s Clickpost Panel. Clickpost dashboard link:
  - Go to Settings
  - Go to the Notification tab
  - Beside the webhook field, there is a “generated key” field. This is your Clickpost Webhook Key.
- Clickpost Account Alias - As there can be multiple clickpost configurations for a single organization, this field is used to identify them. It can be any text.
- Notifications Enabled? - This should be set as true if the client wants Clickpost to push notifications to RMS, otherwise it should be false. If it is set as true, then the push url and credential configuration must also be done on the Push Config page.
Click on the Add button to add the clickpost configuration.
Once added, it will be displayed in a tabular format on the Clickpost Config page.

In this screen, you can add the shiprocket credentials to be used for generating shipping label
On clicking the “+” button, the add shiprocket config window opens

Enter the form details here:
- Shiprocket Username- Shiprocket email to be used in the Shiprocket API calls. You can get this from Shiprocket team.
- Shiprocket Password- Shiprocket Password to be used in the Shiprocket API calls. You can get this from Shiprocket team.
- Shiprocket Webhook Key - The webhook which will be used by Shiprocket to push notifications to RMS. To get this
  - Login to Client’s Shiprocket Panel. Shiprocket dashboard link:
  - Go to Settings
  - In the API section, click on Webhooks
  - There is a “token” field. This is your Shiprocket Webhook Key.
- Shiprocket Account Alias - As there can be multiple shiprocket configurations for a single organization, this field is used to identify them. It can be any text.
- Notifications Enabled? - This should be set as true if the client wants Shiprocket to push notifications to RMS, otherwise it should be false. If it is set as true, then the push url and credential configuration must also be done on the Push Config page.
Click on the Add button to add the shiprocket configuration.
Once added, it will be displayed in a tabular format on the Shiprocket Config page.

In this screen, you can configure the push url and credentials. The push url is the url where RMS will make the API call to send the notification to the client’s system.
On clicking the “+” button, the add push config credentials window will open.

Enter the header name and header values here. These will be passed as headers when RMS makes the notification API call to the client’s system.