To get an idea of which endpoints are available for your application, we recommend going though the API-tester which can be found within the Easyweb API menu.
The /connect/token endpoint should be used by the application to retrieve an access token.
The /routes/ endpoint should be used to retrieve data from routes. When a new page is created, a new routes endpoint is automatically generated.
For pages located on root level inside the pages module the endpoint will look like this:
For pages located inside folders or custom module, the endpoint will include the folder tree or module, like so:
This can go several levels deep:
Routes requests return a response as an object which includes the following keys:
- id (number)
- label (string)
- showDate (string)
- urlName (string)
- custom objects from elements inside specific route.
By default, custom objects within the response only include the value property of the element. This can be extended to include many properties by adding ?includeProperty=:name-of-property suffix to the request endpoint.
By default, the response does not include empty values. By adding the ?includeEmpty=True suffix we can retrieve empty values.
label: "Potato pie",
label: "Pumpkin pie",
Whereas the key "pies" refers to an ArticleList.
The /load/ endpoint should be used to retrieve meta information.
Routes requests return a response as an object. The endpoints that are guaranteed to exist are:
The /load/layout endpoint retrieves data from the layout article.
The /load/menu endpoint retrieves data from the defaulted "Menu" module.
The /load/settings endpoint retrieves data from the defaulted "Settings" module.