Client 🤝

APIs to create and update a partner's clients

Available Endpoints

Type	Description	Endpoint
POST	Create New Client	integrations/client
PUT	Update Client	integrations/client

POST - Create New Client

https://api.gameball.co/api/v3.0/integrations/client

This API is used by partners to create new clients

This endpoint is only available for our Partner customers only 🤝

Request

Header

Attribute	Type	Required	Description
Authorization	string	Yes	Partner Access Token, The token is of type Bearer

Body

Attribute	Type	Required	Description
name	string	Yes	Name of the Client
email	string	Yes	Email of the Client
mobile	string	Yes	Mobile Number of the Client
storeName	string	Yes	Store Name or any unique identifier from the system of the partner (This attribute will later be used to access APIs on behalf of the client)
domain	string	Yes	Domain of the store of the Client
country	string	Yes	Country of the store
currency	string	Yes	Currency of the store
timeZone	string	Yes	Timezone of the store
isLoyaltyEnabled	boolean	No	A Boolean flag indicating if the store's Loyalty Program will be enabled once they are created or not (Default value is false)
customDomain	string	No	Custom Domain of the store
plan	string	No	Name of the Partner's plan that the client is subscribed to (Default is Free)
status	string	No	Status of the Client in the partner's system, could be one of the following: active, trial, suspended, uninstall (Default value is active)
subscriptionId	integer	No	The id of the client's subscription on the partner’s system

Sample Request Body

{
  "name": "Jon Snow",
  "email": "[e-mail]",
  "mobile": "+01010101010",
  "plan": "Pro",
  "isLoyaltyEnabled": true,
  "storeName": "MyNewStore",
  "domain": "mynewstore.com",
  "customDomain": "mynewstore.custom.com",
  "currency": "USD",
  "timezone": "GMT+1",
  "status": "active",
  "country": "Saudi Arabia",
  "subscriptionId": 23
}

Response

Parameter	Type	Description
apiKey	string	The newly created client's APIKey
secretKey	string	The newly created client's secretKey
gameballId	integer	The ID of the newly created client in Gameball's system

Store these values somewhere safe for later usage

Sample Response

{
    "apiKey": "e4ed9964dba843a98aa231cfca1c00ed",
    "secretKey": "0ba56fe05f604463a27b883809833a19",
    "gameballId": 12345
}

PUT - Update Client

https://api.gameball.co/api/v3.0/integrations/client

This API is used by partners to update clients

This endpoint is only available for our Partner customers only 🤝

Request

Header

Attribute	Type	Required	Description
Authorization	string	Yes	Partner Access Token, The token is of type Bearer
storeId	string	Yes	Id of the store on the partner's system

Only parameters that will be updated should be sent

Body

Attribute	Type	Description
name	string	Name of the Client
email	string	Email of the Client
storeName	string	Store Name or any unique identifier from the system of the partner (This attribute will later be used to access APIs on behalf of the client)
domain	string	Domain of the store of the Client
country	string	Country of the store
currency	string	Currency of the store
timeZone	string	Timezone of the store
isLoyaltyEnabled	boolean	A Boolean flag indicating if the store's Loyalty Program will be enabled once they are created or not
customDomain	string	Custom Domain of the store
plan	string	Name of the Partner's plan that the client is subscribed to
status	string	Status of the Client in the partner's system, could be one of the following: active, trial, suspended, uninstall
subscriptionId	integer	The id of the client's subscription on the partner’s system

Sample Request

{
  "status": "trialing",
  "name": "New Name",
  "email": "[e-mail]",
  "mobile": "010010101010",
  "storeName": "NewStoreName",
  "isLoyaltyEnabled": true
}

Response

Attribute	Type	Description
id	integer	Id of the client in Gameball's system
name	string	Name of the Client
email	string	Email of the Client
storeName	string	Store Name or any unique identifier from the system of the partner (This attribute will later be used to access APIs on behalf of the client)
domain	string	Domain of the store of the Client
country	string	Country of the store
currency	string	Currency of the store
timeZone	string	Timezone of the store
isLoyaltyEnabled	boolean	A Boolean flag indicating if the store's Loyalty Program will be enabled once they are created or not
customDomain	string	Custom Domain of the store
plan	string	Name of the Partner's plan that the client is subscribed to
status	string	Status of the Client in the partner's system, could be one of the following: active, trial, suspended, uninstall
subscriptionId	integer	The id of the client's subscription on the partner’s system

Sample Response

{
    "id": 1234,
    "name": "Jon Snow",
    "email": "[e-mail]",
    "mobile": "+01010101010",
    "plan": "Pro",
    "isLoyaltyEnabled": true,
    "storeName": "MyNewStore",
    "domain": "mynewstore.com",
    "customDomain": "mynewstore.custom.com",
    "currency": "USD",
    "timezone": "GMT+1",
    "status": "active",
    "country": "Saudi Arabia",
    "subscriptionId": 23
  }