Operator

Overview

The operator is used to create API credentials that will be used in the API endpoints as an authorization key. API credentials content both test and live keys for both public and private environments.

Operator Request Example

To obtain API credentials, send a multipart/form-data request with the specified parameters as listed in the Operator Request table.

Operator Request Table (multipart/form-data)

Field Name	Field Type	Descriptions	Data Formate
`wallet_id`	string	required Wallet ID that should be connected to the operator	Text Example:'wal_xxx'
`developer_id`	string	required	Text Example:'dev_xxx'
`name`	string	required	Unique Text
`terminal_id`	string	optional Terminal ID that should be connected to the operator	Text
`platform`	string	optional Which platform the operator will be used for	Text
`brands`	array[object]	optional Brands object.	[ { "brand_id":"String", "branch_id": ["String"] } ]
`toolkit`	object	optional Toolkit object	{ "type":"String", "version":"String" }
`app`	object	optional App object	{ "type":"String", "url":"String", "development_language":"String", "os":"String", "bundle_id":"String", "locale":"String" }

Request Example


{
  "wallet_id": "wal_C03P2419164361xT12NL10s669",
  "developer_id": "dev_P2419164361xcZUV21916",
  "name": "Web",
  "platform": "mobile",
  "brands": [
    {
      "brand_id": "brd_cZUV2191640Z3Op12YV10b779",
      "branch_id": [
        "brc_2Ft76191640YnBk12y5105800"
      ]
    }
  ],
  "toolkit": {
    "type": "iOS_SDK",
    "version": "2.2.6"
  },
  "app": {
    "type": "mobile",
    "url": "sdcfs",
    "development_language": "swift",
    "os": "iOS",
    "bundle_id": "com.test.application",
    "locale": "en"
  }
}

Operator Response Example

This section will show the response after creating an Operator.

Operator Response Table (JSON)

Field Name	Field Type	Description
`id`	string	optional Unique identifier of operator
`status`	string	optional Unique identifier of operator
`created`	integer	optional Operator created time stamp
`object`	string	optional operator
`live_mode`	boolea	optional Define live mode or sandbox mode (true or false)
`api_version`	string	optional Version of this API
`feature_version`	string	optional Version of this feature
`name`	string	optional
`business_id`	string	optional business id that is connected
`business_entity_id`	string	optional business entity id that is connected
`brands`	array[object]	optional brands object
`wallet_id`	string	optional wallet id that is connected
`platform`	string	optional platform used
`toolkit`	object	optional toolkit object
`app`	object	optional app object
`api_credentials`	object	optional api_credentials object used to access tap API's

Response Example


{
  "id": "opr_cXvn14191558ZuAP14dd101978",
  "status": "Active",
  "created": 1573736294978,
  "object": "Operator",
  "live_mode": false,
  "api_version": "v2",
  "feature_version": "v2",
  "business_id": "bus_GDpQ53191639IYC412W210L218",
  "business_entity_id": "ent_zPcc59191639VjPC12xX10I279",
  "brands": [
    {
      "brand_id": "brd_cZUV2191640Z3Op12YV10b779",
      "branch_id": [
        "brc_2Ft76191640YnBk12y5105800"
      ]
    }
  ],
  "wallet_id": "wal_C03P2419164361xT12NL10s669",
  "platform": "mobile",
  "toolkit": {
    "type": "iOS_SDK",
    "version": "2.2.6"
  },
  "app": {
    "type": "mobile",
    "url": "sdcfs",
    "os": "iOS",
    "bundle_id": "com.test.application",
    "locale": "en"
  },
  "api_credentials": {
    "test": {
      "secret": "sk_test_Lc704RwybGXmAUSo5plqgTaI",
      "public": "pk_test_zOye9K7r0LM2Ig4YUJBj1ZtQ"
    },
    "live": {
      "secret": "sk_live_iy4SKO3NpUxzrRPugbEoDHnZ",
      "public": "pk_live_bLZjFaSEeOxt93ikV7ADWg5T"
    }
  }
}