Glue API: Resolve search engine friendly URLs
Edit on GitHubThis is a document related to the Old Glue infrastructure. For the new one, see Decoupled Glue API
This endpoints allows resolving Search Engine Friendly (SEF) URLs into a resource URL in Glue API.
For SEO purposes, Spryker automatically generates SEF URLs for products and categories. The URLs are returned as a url
attribute in responses related to abstract products and product categories. For examples of such responses, see:
In your development, the endpoints can help you to:
- significantly boost the SEO presence of your product store
- increase search engine ranking of your online store
To facilitate their usage, Spryker Glue provides an endpoint that allows resolving a SEO-friendly URL, for example, http://mysprykershop.com/en/canon-powershot-n-35
, into a URL of the relevant product resource in Glue API, for example, https://glue.mysprykershop.com/abstract-products/035
. This capability is provided by the URLs API.
Installation
For detailed information on the modules that provide the API functionality and related installation instructions, see Install the Spryker Core Glue API.
Resolve a SEF URL into a Glue API URL
To resolve a SEF URL into a Glue API URL, send the request:
GET
/url-resolver?url={{SEF URL}}
PATH PARAMETER | DESCRIPTION |
---|---|
{{SEF URL}} | SEF URL you want to resolve. You can get it when: |
Request
HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION |
---|---|---|---|
Accept-Language | de | ✓ | Specifies the locale. |
REQUEST SAMPLE | USAGE |
---|---|
GET https://glue.mysprykershop.com/url-resolver?url=/de/acer-aspire-s7-134 | Resolve the following URL of a product: https://mysprykershop.com/de/acer-aspire-s7-134 |
GET https://glue.mysprykershop.com/url-resolver?url=/en/computer | Resolve the following URL of a category node: https://mysprykershop.com/en/computer |
GET https://glue.mysprykershop.com/url-resolver?url=/de/ruecknahmegarantie | Resolve the following URL of a CMS page https://mysprykershop.com/de/ruecknahmegarantie |
Response
Response sample: resolve a product URL
{
"data": [
{
"type": "url-resolver",
"id": null,
"attributes": {
"entityType": "abstract-products",
"entityId": "134"
},
"links": {
"self": "https://glue.mysprykershop.com/url-resolver?url=/de/acer-aspire-s7-134"
}
}
],
"links": {
"self": "https://glue.mysprykershop.com/url-resolver?url=/de/acer-aspire-s7-134"
}
}
Response sample: resolve a category node URL
{
"data": [
{
"type": "url-resolver",
"id": null,
"attributes": {
"entityType": "category-nodes",
"entityId": "5"
},
"links": {
"self": "https://glue.mysprykershop.com/url-resolver?url=/en/computer"
}
}
],
"links": {
"self": "https://glue.mysprykershop.com/url-resolver?url=/en/computer"
}
}
Response sample: resolve a CMS page URL
{
"data": [
{
"type": "url-resolver",
"id": null,
"attributes": {
"entityType": "cms-pages",
"entityId": "8d378933-22f9-54c7-b45e-db68f2d5d9a3"
},
"links": {
"self": "https://glue.mysprykershop.com/url-resolver?url=/en/return-policy"
}
}
],
"links": {
"self": "https://glue.mysprykershop.com/url-resolver?url=/en/return-policy"
}
}
ATTRIBUTE | TYPE | DESCRIPTION |
---|---|---|
entityType | String | Resource type, like abstract-products or category-nodes , cms-pages . |
entityId | String | Unique resource identifier. |
Using the information from the response and the Glue server name, you can construct the Glue resource URLs. For example:
https://glue.mysprykershop.com/abstract-products/134
https://glue.mysprykershop.com/category-nodes/5
https://glue.mysprykershop.com/cms-pages/8d378933-22f9-54c7-b45e-db68f2d5d9a3
Possible errors
CODE | REASON |
---|---|
2801 | The url parameter is missing. |
2802 | The provided URL does not exist. |
To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.
Thank you!
For submitting the form