Skip to content

HATEOAS

The novomind iSHOP API is based on the principles of hateoas. The idea is that each returned resource also contains links to resources somehow related to the current resource. A category, for instance, does not return all its child categories but links to the child categories.

Here an example category:

json
{
    "id":"29918",
    "name":"Fashion",
    "links":[
        {
            "rel":"child",
            "href":"https://www.example.com/ishop-api/shop/categories/296093/",
            "description":null,
            "security":"none"
        },
        {
            "rel":"products",
            "href":"https://www.example.com/ishop-api/shop/categories/29918/products/",
            "description":null,
            "security":"none"
        }
    ]
}

The novomind iSHOP API is consistently build upon this paradigma. So you need only a single entry point (Usually the <<shop url>>/ishop-api/) and in the response you will find links to subresources of that current resource.