What is needed to set up a new integrator?

Name

The name of the integrator, this is also the name that is displayed to the end users

Description

Short description of the integrator

Support email

Support email that our customers can use to reach the integrator in case of errors in the integration.

Url

What URL should be opened when a user of Core creates a new order or opens an existing one. This URL supports multiple merge fields:

CASE_ID

The case in which the call was made. Example: $CaseId=10351

ACCESS_TOKEN

A token generated by Flow, or by the integrator, depending on the method of authorization used. Example: $Token=”wuqxehPbcM5n65DaZ_Ug2H…”

CUSTOMER_NAME

Customer name in string format. Differs between testing, development and production environments. Example: $CustomerName=”Flow - Customername Development”

FLOW_URL

Base url for the customer. Example: &FlowUrl=”https://environment.webtopsolutions.com/flow/)

ORDER_ID

GUID for the order. Generated by Flow on creation of a new order. Example: &OrderId=”00000000-0000-0000-0000-000000000000”

TENANT_ID

Unique ID per customer. Example: &TenantId=14

Example:

123.no/new/integrator?caseId=&token=&StreamOrderId=

PingUrl

An url which we can use to ping the service to see if it is online

Authentication type

The generated token is added to query params (if specified in merge fields).

OAuthSimplified

To use this method, this needs to be provided:

• Authentication url
• ClientId
• ClientSecret

Execution:

POST URL Authentication url Body client_id: string = ClientId client_secret: string = ClientSecret Response token: string Content-Type: application/json

OAuth

To use this method, this needs to be provided:

• Authentication url
• ClientId
• ClientSecret

Uses standard OAuth with client credentials. Content-Type: application/json.

Basic authentication

To use this method, this needs to be provided:

• Username
• Password Converts username and password to hash/token following normal standard.

FlowToken

Generates a Flow token that is added to the query params. This token is valid for 60 seconds. One-time-use to verify that Core is the source of the URL. After a token is verified it will no longer be needed. Use Flow API to validate token

POST /flow/api/MarketingIntegrators/VerifyToken

Body
Token: string
Response is information about user that generated the token MarketingIntegratorTokenModel NB: You still need to include header authentication (bearer token from client user authentication)

Display method

How the integration should be displayed in Core. We have four options:

• Open in new tab (redirect)
• New window
• iFramed
• Open in new tab

Note that framing a website requires Core to whitelist your url / domain. If this url is changed after whitelisting, the domain needs to be whitelisted again. Notify us in a timely manner if this is the case.