Page Comparison

...

In instances where there is a need to create a new broker within a specific account utilizing the Thinksurance Public API V1, henceforth referred to as "the API," a dedicated endpoint facilitates this capability. This endpoint is accessible at the path /api/broker/set/{:token}ipn/brokers. It anticipates a comprehensive payload as part of the HTTP request, encompassing the requisite broker data.

...

To create a broker via the API, it is imperative to send an HTTP POST request to the endpoint /api/broker/set/{:token}. The parameterised segment of the endpoint, denoted as "{:token}," contains to the security token retrievable by the partner during the Authentication process on the API. The ipn/brokers. The rest of the HTTP request is a JSON payload of the request body.

Action name

create broker

HTTP path

/api/broker/set/{:token}

token - a security token retrieved from Authentication

ipn/brokers

HTTP method

POST

Attributes of the HTTP request

HTTP Request Header
Authorization	string	required	A security token provided from Authentication endpoint. Required to provide as a Bearer Token (in format: “Bearer {{token}}“).
X-Account-Token	string	required	An unique identifier of the account.

Broker Parameters

The initial set of parameters pertains to broker data. Only specific elements within this data subset are mandatory for delivery. These required elements assist the API in providing critical information for the broker creation.

...

aToken

...

string

...

required

...

.

type

int

required

Enumeration value that defines the way for mapping broker data from the request:

1 - it requires to have broker’s ID from the partner system provided to Thinksurance System
2 - it doesn’t requires to have broker’s ID from the partner system provided to Thinksurance System

bExternalId

string

required

Broker’s ID from the partner system.

bGender

int

optional

Enumeration value that defines salutation of the broker person:

1 - Mr
2 - Ms

bFirstName

string

optional

Broker person’s first name.

bLastName

string

required¹

Broker person’s last name.

bEmail

string

required

Broker person’s email address.

bCompany

string

required²

Broker company’s name.

bStreet

string

optional

Broker company’s street name.

bStreetNumber

string

optional

Broker company’s street number.

bZip

string

optional

Broker company’s postcode.

bCity

string

optional

Broker company’s city.

bPhone

string

optional

Broker company’s phone number.

bCompanyRegNumber

string

optional

Broker company’s commercial register number.

bRegNumber

string

optional

Broker company’s IHK register number.

Explanations:

Anchor

	broker
	broker
isMissingRequiredParameters	true

¹ required if bCompany is not set
² required if bLastName is not set

Attributes of the HTTP response

...

As previously stated, to execute Broker Create, it is imperative to dispatch a POST HTTP request to the /api/broker/set/{:token}ipn/brokers endpoint of the API. Below, instances of potential communication between the API and consumers are provided.

HTTP Request with minimal data for company

Code Block

language	json

# HTTP POST
# https://ipn.dev.thinksurance.de/api/broker/set/{:token}ipn/brokers
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{# 'Authorization':  "aToken": "some string as an identifier",'Bearer <some long string value>'
# 'X-Account-Token': '<some hash>'
{
  "type": 1,
  "bExternalId": "T5",
  "bEmail": "awesome.gmbh@email.com",
  "bCompany": "Awesome GmbH"
}

HTTP Request with minimal data for a person

Code Block

language	json

# HTTP POST
# https://ipn.dev.thinksurance.de/api/broker/set/{:token}ipn/brokers
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{# 'Authorization':  "aToken": "some string as an identifier",'Bearer <some long string value>'
# 'X-Account-Token': '<some hash>'
{
  "type": 1,
  "bExternalId": "T5",
  "bEmail": "mustermann@email.com",
  "bLastName": "Mustermann"
}

Successful HTTP Response

Code Block

language	json

# HTTP 200 status code
# 'Content-Type': 'application/json'
{
  "status": "Broker Api: broker created succesfully.",
  "bToken": "some hashed string"
}

Failed HTTP Response

Code Block

language	json

# HTTP 200 status code
# 'Content-Type': 'application/json'
{
  "error": "API User is not existing or deactivated."
}

Versions Compared

Old Version 2

New Version 3

Key

Attributes of the HTTP request

Broker Parameters

Attributes of the HTTP response