Versions Compared

Version Old Version 2 New Version 3
Changes made by

Marko Milojevic

Marko Milojevic

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

bToken

string

required

A special token used for broker to identify itself during API calls. Provided by Thinksurance Support Team.

agencyNumbers

array

required

An array that holds information on all agency numbers that should be added. Each item of the array is represented by Agency Number Holder Scheme bellow.

Agency Number Holder Scheme

Anchor
holder
holder

baFinId

string

optional1

An insurer’s BaFin number.

insurerId

string

optional1

An insurer’s unique identifier number.

supervisingAuthorityId

string

optional1

e2e

array

optional2

An array that holds information on all agency numbers that should be added for one insurer, that should be used with deals made by calculation. Each item of the array is represented by Agency Number Scheme bellow.

db

array

optional2

An array that holds information on all agency numbers that should be added for one insurer, that should be used with deals made in tendering process. Each item of the array is represented by Agency Number Scheme bellow.

Agency Number Scheme

Anchor
agency
agency

brokerAgencyNumber

string

required

The actual agency number.

brokerAgencyEmail

string

optional

Broker’s contact email.

brokerAgencyName

string

optional

Broker’s contact name.

brokerAgencyPhone

string

optional

Broker’s contact phone.

Explanations:

Anchor
explanations
explanations

1 one parameter out of baFinId, insurerId and supervisingAuthorityId is required
2 one parameter out of db and e2e is required

...

As previously stated, to execute Add Agency Number, it is imperative to dispatch a POST HTTP request to the /api/broker/set/anums/{:token} 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
languagejson
# HTTP POST
# https://app.dev.thinksurance.de/api/broker/set/anums/{:token}
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{
   "bToken":"<some short hash>",
   "agencyNumbers":[
      {
         "baFinId":"5405",
         "e2e":{
            "brokerAgencyNumber":"api-e2e-alte-deal",
            "brokerAgencyName":"API ALTE CONTACT",
            "brokerAgencyPhone":"api-phone-alte",
            "brokerAgencyEmail":"api-e2e-test@gv24.de"
         },
         "db":{
            "brokerAgencyNumber":"api-e2e-alte-dealdb",
            "brokerAgencyName":"API ALTE CONTACTdb",
            "brokerAgencyPhone":"api-phone-altedb",
            "brokerAgencyEmail":"api-e2e-test@gv24db.de"
         }
      },
      {
         "baFinIdinsurerId":"5036",
         "e2e":{
            "brokerAgencyNumber":"api-e2e-arag-deal",
            "brokerAgencyEmail":"api-e2e-arag@gv24.de"
         },
         "db":{
            "brokerAgencyNumber":"testi",
            "brokerAgencyName":"Herr Testi",
            "brokerAgencyPhone":"Herr Telefon",
            "brokerAgencyEmail":"testiDB@gv24db.de"
         }
      },
      {
         "baFinIdsupervisingAuthorityId":"61234",
         "e2e":{
            "brokerAgencyNumber":"api-e2e-arag-deal1",
            "brokerAgencyEmail":"api-e2earag1@gv24.de"
         }
      }
   ]
}

Successful HTTP Response

Code Block
languagejson
# HTTP 200 status code
# 'Content-Type': 'application/json'
{
  "status": "Broker Api: agency number added succesfully."
}

Failed HTTP Response

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