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/products 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. Additionally, should there be a necessity to filter products by professions, an optional attribute, professionId, can be included as part of the JSON payload.

Action name

get products

HTTP path

/api/ipn/products

HTTP method

POSTGET

Attributes of the HTTP request

...

HTTP Request without profession filter

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

HTTP Request with profession filter

Code Block
# HTTP POSTGET
# https://ipn.dev.thinksurance.de/api/ipn/products
#
# HTTP headers
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
# 'Authorization': 'Bearer <some long string value>'
#
{
  "professionId": 123
}

Successful HTTP Response

Code Block
# HTTP 200 status code
# 'Content-Type': 'application/json'
[
  {
    "id": 1,
    "name": "Product1"
  },
  {
    "id": 2,
    "name": "Product2"
  }
]

Failed HTTP Response

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