Redirecting to your connector when the Merchant selects the Platform

This is the initial request from Rally's systems sent to the Connector when a Merchant selects the Connector for installation.

Request
query Parameters
api_key
required
string

The API key as found in the Partners Dashboard

Example: api_key=9312f698-78e7-4b47-852b-efc9db700fd6
organization_id
required
string

The ID of the organization currently installing the connector app

Example: organization_id=org_ABC
external_id
string

The store ID, as noted in the platform. This is only provided when reconnecting the store.

Example: external_id=6m3mcoha7z
scopes
required
Array of strings unique

The scopes, as approved by the Merchant when installing a specific connector

Items Enum: "read:merchant_data" "write:merchant_data" "read:assets" "write:assets" "read:webhooks" "write:webhooks" "read:rally_hooks" "write:rally_hooks"
Example: scopes=read:merchant_data,write:merchant_data,read:assets,write:assets
code
required
string

Authorization grant code

Example: code=A1x91jxp91ja
redirect_uri
required
string

The URL of where Rally's API expect you to redirect back to from the connector

Example: redirect_uri=https://admin.onrally.com/extensions
timestamp
required
integer
Default: 1628667161

Timestamp, in an epoch format

Example: timestamp=1628667161
hmac
required
string

HMAC so you can validate the request coming from Rally's servers

Example: hmac=ZHbVzaSYLJhfzAS/ViNst6hsIfpLXJwzLGJxDRalee0=
Responses
200

Rally expects you to redirect back to the redirect_uri provided at the time of the initial request so Rally can finalize the installation process

412

Merchants are forbidden to connect stores that are used in existing installations by other merchants and can only reconnect to the same store they have already configured, if any

get/redirect
Request samples
Response samples
application/json
{
  • "error": "Merchants can only (re)connect to the same store.",
  • "error_code": "forbidden_install"
}
Copyright © Rally Commerce, Inc. 2023. All right reserved.