Page Comparison

...

To retrieve products, consumers are required to send an HTTP 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 payloada HTTP GET parameter.

Action name	get products
HTTP path	/api/ipn/products
HTTP method	GET

...

HTTP Request Header
Authorization	string	required	A security token provided from Authentication endpoint. Required to provide as a Bearer Token (in format: “Bearer {{token}}“).
JSON BodyHTTP GET parameter
professionId	int	optional	An attribute used to filter out all products for particular profession.

...

HTTP Request without profession filter

Code Block

# HTTP GET
# 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 GET
# https://ipn.dev.thinksurance.de/api/ipn/products?professionId=123
#
# 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." }

Versions Compared

Old Version 5

New Version 6

Key