Versions Compared

Key

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

...

To retrieve products, consumers are required to send an HTTP POST GET request to the /api/ipn/insurers endpoint. This endpoint requires the security token, obtained during the Authentication process on the API, as an integral component of the JSON payload within the body of the request.

Action name

get insurers

HTTP path

/api/ipn/insurers

HTTP method

POSTGET

Attributes of the HTTP request

...

This section shows examples of different HTTP requests and responses associated with the endpoint /api/ipn/insurers.

HTTP Request

Code Block
languagejson
# HTTP POSTGET
# https://ipn.dev.thinksurance.de/api/ipn/insurers
#
# HTTP headers
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
# 'Authorization': 'Bearer <some long string value>'
#

Successful HTTP Response

Code Block
languagejson
# HTTP 200 status code
# 'Content-Type': 'application/json'
[
  {
    "id": 1,
    "name": "Insurer1",
    "bafin": "id123456"
  },
  {
    "id": 2,
    "name": "Insurer2",
    "bafin": "id654321"
  }
]

Failed HTTP Response

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