UtilitiesSlugify Endpoint

Overview

URL's are very important and in Hotcakes we allow you to specify the best URL's you can think of in the most important areas.  This endpoint allows you to pass it a desired set of slug text, and it will return a URL-safe version of it.  This is useful to pass to your product and category update/create methods.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript
  • Visual Studio 2012 or newer

Getting Started

You should already have a project open and ready to accept code to allow you to use this REST API endpoint.  

UtilitiesSlugify

This REST API endpoint allows you to index a product in your store. 

Example URL

This is what the REST endpoint will look like if you are calling it using JavaScript.  See our REST API URL documentation for more information.

http://example.com/DesktopModules/Hotcakes/API/rest/v1/utilities/slugify

HTTP Method

POST

Parameters

Parameter Description
postdata This is the text that you wish to parse as a slug to use for a URL

Returns

If successful, this endpoint will return the URL-safe slug in the ApiResponse.Content object.  Otherwise, you should have one or more errors returned.  

Example Code

The following code will allow you to successfully call this endpoint, provided that you have enabled it.

Project References

  • Hotcakes.CommerceDTO

Import Namespaces

  • Hotcakes.CommerceDTO.v1
  • Hotcakes.CommerceDTO.v1.Client

 

string url = "http://example.com";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// specify the value to parse and return as a URL-safe slug
var urlValue = "Community Favorites";

// call the API to slugify the given value
ApiResponse<string> response = proxy.UtilitiesSlugify(urlValue);
// your domain name
var url = "http://example.com"; 
// the path where the API is
var apiPath = "/DesktopModules/Hotcakes/API/rest/v1/";  
// endpoint as shown in the documentation
var endPoint = "utilities";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the value to parse and return as a URL-safe slug
    var urlValue = "Community Favorites";

    // call the API to slugify the given value
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/slugify?key=" + apiKey,
        data: urlValue,
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":"Community-Favorites"
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.