Stream Partner API (1.0)

Download OpenAPI specification:Download

The Enterprise API for all Stream Partners.

Tokens

getPartnerTokens

Authorizations:

bearer

query Parameters

org_id

required

string

Responses

Response samples

200

Content type

application/json

[{ }
]

createPartnerToken

Authorizations:

bearer

Request Body schema: application/json

org_id required	string
token_name required	string
scopes required	Array of strings Items Enum: "user" "onboarding" "legacy_onboarding" "sso" "billing"

Responses

Request samples

Payload

Content type

application/json

{"org_id": "string",
"token_name": "string",
"scopes": ["user"
]
}

Response samples

201

Content type

application/json

{ }

renamePartnerToken

Authorizations:

bearer

path Parameters

token_id

required

string

Request Body schema: application/json

token_name

required

string

Responses

Request samples

Payload

Content type

application/json

{"token_name": "string"
}

Response samples

200

Content type

application/json

{ }

deletePartnerToken

Authorizations:

bearer

path Parameters

token_id

required

string

Responses

OAuth

token

Request Body schema: application/json

grant_type required	string Enum: "client_credentials" "refresh_token" The type of grant you are requesting, must be "client_credentials" or "refresh_token"
client_id required	string The API Key given by the application
client_secret required	string The API Token given by the application
exp	number The expiration time of the assertion, specified as seconds since 00:00:00 UTC, January 1, 1970. This value has a maximum of 1 hour after the issued time.
scopes	Array of strings Items Enum: "user" "onboarding" "legacy_onboarding" "sso" "billing" The list of the permissions that the application requests.
refresh_token	string The refresh token only when grant_type is set to "refresh_token"

Responses

Request samples

Payload

Content type

application/json

{"grant_type": "client_credentials",
"client_id": "string",
"client_secret": "string",
"exp": 0,
"scopes": ["user"
],
"refresh_token": "string"
}

Response samples

201

Content type

application/json

{"access_token": "string",
"token_type": "bearer",
"refresh_token": "string",
"expires_in": 0,
"refresh_token_expires_in": 0,
"scopes": ["user"
]
}

White Label - SSO

generateSSOSession

Authorizations:

bearer

query Parameters

partner_id

string

Request Body schema: application/json

email required	string
full_name required	string
phone_number required	string
role	string Enum: "owner" "admin" "manager" "team_member" "custom"
provider_org_id	string
provider_org_name	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"full_name": "string",
"phone_number": "string",
"role": "owner",
"provider_org_id": "string",
"provider_org_name": "string"
}

Response samples

201

Content type

application/json

{"sso_login_token": "string"
}

Onboarding - Integrations

Initialize OAuth integration flow

Initializes OAuth flow and returns an entry_url to begin authorization.

Authorizations:

bearer

Request Body schema: application/json

org_id required	string
source required	string
type required	string Enum: "pos" "dsp"
return_url required	string

Responses

Request samples

Payload

Content type

application/json

{"org_id": "string",
"source": "string",
"type": "pos",
"return_url": "string"
}

Response samples

201

Content type

application/json

{"onboarding": {"_id": "string",
"org_id": "string",
"merchant_id": "string",
"type": "pos",
"status": "pending",
"partner_id": "string",
"partner_org_id": "string",
"source": "string",
"entry_url": "string",
"return_url": "string",
"integration_id": "string"
}
}

Get OAuth integration status

Retrieves current status and details of an onboarding integration.

Authorizations:

bearer

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"org_id": "string",
"merchant_id": "string",
"type": "pos",
"status": "pending",
"partner_id": "string",
"partner_org_id": "string",
"source": "string",
"entry_url": "string",
"return_url": "string",
"integration_id": "string"
}

Complete OAuth integration

Exchanges OAuth code from redirect URL and activates the integration.

Authorizations:

bearer

path Parameters

id

required

string

Request Body schema: application/json

code

required

string

Responses

Request samples

Payload

Content type

application/json

{"code": "string"
}

Response samples

200

Content type

application/json

{"_id": "string",
"org_id": "string",
"merchant_id": "string",
"type": "pos",
"status": "pending",
"partner_id": "string",
"partner_org_id": "string",
"source": "string",
"entry_url": "string",
"return_url": "string",
"integration_id": "string"
}

Revoke OAuth integration

Revokes OAuth access and deprovisions the active integration.

Authorizations:

bearer

path Parameters

id

required

string

Responses

Onboarding - Locations

List onboarding locations

Retrieves locations associated with an onboarding integration

Authorizations:

bearer

query Parameters

onboarding_id

required

string

Responses

Response samples

200

Content type

application/json

{"locations": [{"provider_id": "string",
"name": "string",
"address": {"formatted_address": "string",
"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"postal_code": "string",
"locality": "string",
"administrative_district_level_1": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"source": "string"
}
]
}

Ingest POS locations

Imports location data from the point-of-sale system

Authorizations:

bearer

Request Body schema: application/json

onboarding_id required	string
required	Array of objects (IngestOnboardingLocation)

Responses

Request samples

Payload

Content type

application/json

{"onboarding_id": "string",
"locations": [{"provider_id": "string"
}
]
}

Response samples

201

Content type

application/json

{"locations": [{"_id": "string",
"provider_id": "string"
}
]
}

Bind DSP locations

Associates DSP locations with POS locations

Authorizations:

bearer

Request Body schema: application/json

onboarding_id required	string
required	Array of objects (BindOnboardingLocation)

Responses

Request samples

Payload

Content type

application/json

{"onboarding_id": "string",
"locations": [{"pos_location_id": "string",
"dsp_provider_id": "string",
"dsp_store_name": "string"
}
]
}

Response samples

201

Content type

application/json

{"locations": [{"_id": "string",
"dsp_provider_id": "string",
"dsp_store_name": "string",
"status": "APPROVED"
}
]
}

Onboarding - Org

Create organization

Creates a new organization in the partner whitelabel

Authorizations:

bearer

Request Body schema: application/json

name required	string
provider_id required	string
required	object (CreateUserOrgUser)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"provider_id": "string",
"user": {"email": "string",
"first_name": "string",
"last_name": "string"
}
}

Response samples

201

Content type

application/json

{"org_id": "string",
"user_id": "string"
}

List organization locations

Returns POS or DSP locations for an organization

Authorizations:

bearer

path Parameters

id

required

string

query Parameters

location_id

string

Responses

Response samples

200

Content type

application/json

{"locations": [{"_id": "string",
"name": "string",
"source": "string",
"status": "active",
"address": {"formatted_address": "string",
"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"postal_code": "string",
"locality": "string",
"administrative_district_level_1": "string",
"country": "string",
"latitude": 0,
"longitude": 0
},
"dsps": [{"_id": "string",
"name": "string",
"source": "string",
"status": "APPROVED",
"change_time": 0
}
]
}
]
}

getBillingReports

query Parameters

partner_id

string

Responses

Response samples

200

Content type

application/json

{ }

getRawReportData

query Parameters

file_name required	string
partner_id required	string

Responses

Response samples

200

Content type

application/json

{"reportMonth": "string",
"partnerId": "string",
"locations": [{ }
],
"metrics": {"activeLocations": 0,
"newActivations": 0,
"newOnboardings": 0
}
}

getBillingReportInvoice

query Parameters

file_name required	string
partner_id required	string

Responses

Response samples

200

Content type

application/json

"string"

Feature Flags

List all feature flags visible to the authenticated partner

Authorizations:

bearer

Responses

Response samples

200

Content type

application/json

{"flags": [{ }
]
}

Get details of a specific feature flag

Authorizations:

bearer

path Parameters

flagKey

required

string

Responses

Response samples

200

Content type

application/json

{"flag": { }
}

List all contexts targeted by a flag

Authorizations:

bearer

path Parameters

flagKey

required

string

Responses

Response samples

200

Content type

application/json

{"targets": { }
}

Add contexts to a flag's targeting

Authorizations:

bearer

path Parameters

flagKey

required

string

Request Body schema: application/json

required	Array of objects (ContextDto) Contexts to add
variation	number Variation ID (optional)

Responses

Request samples

Payload

Content type

application/json

{"contexts": [{"key": "string",
"kind": "string"
}
],
"variation": 0
}

Remove contexts from a flag's targeting

Authorizations:

bearer

path Parameters

flagKey

required

string

Request Body schema: application/json

required

Array of objects (ContextDto)

Contexts to remove

Array

key required	string Context key (user ID or entity ID)
kind required	string Context kind

Responses

Request samples

Payload

Content type

application/json

{"contexts": [{"key": "string",
"kind": "string"
}
]
}

Feature Flags - Segments

List all segments visible to the authenticated partner

Authorizations:

bearer

Responses

Response samples

200

Content type

application/json

{"segments": [{ }
]
}

Get details of a specific segment

Authorizations:

bearer

path Parameters

segmentKey

required

string

Responses

Response samples

200

Content type

application/json

{"segment": { }
}

List all contexts in a segment

Authorizations:

bearer

path Parameters

segmentKey

required

string

Responses

Response samples

200

Content type

application/json

{"contexts": [{ }
]
}

Add contexts to a segment

Authorizations:

bearer

path Parameters

segmentKey

required

string

Request Body schema: application/json

required

Array of objects (ContextDto)

Contexts to add

Array

key required	string Context key (user ID or entity ID)
kind required	string Context kind

Responses

Request samples

Payload

Content type

application/json

{"contexts": [{"key": "string",
"kind": "string"
}
]
}

Remove contexts from a segment

Authorizations:

bearer

path Parameters

segmentKey

required

string

Request Body schema: application/json

required

Array of objects (ContextDto)

Contexts to remove

Array

key required	string Context key (user ID or entity ID)
kind required	string Context kind

Responses

Request samples

Payload

Content type

application/json

{"contexts": [{"key": "string",
"kind": "string"
}
]
}