Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In a URL, your key would be used like this:

Code Block

http://menus.singleplatform.co/restaurants/haru-7/menusmenu?apiKey=YOUR_API_KEY_HERE

In the JavaScript API, your key would be used like this:

Code Block

<script type="text/javascript" src="http://menus.singleplatform.co/jsload?load=menus.2&apiKey=YOUR_API_KEY_HERE"></script>
<script>
    var menuApi = new MenusApi("YOUR_API_KEY_HERE");
    menuApi.loadMenusForLocation("haru-7", "menusContainer");
</script>

...

These are the steps you should use to sign a valid URL:

  1. Construct your URL. Make sure to include the clientparameter. Note, any non-standard characters need to be URL-encoded.

    Code Block
    
    http://api.singleplatform.co/restaurants/haru-7?client=YOUR_CLIENT_ID
    
    Note

    All SinglePlatform services require UTF-8   character encoding, which implicitly includes ASCII. Make sure your applications construct URLs using UTF-8   and properly URL-encoded characters, particularly if your application works with other character sets.

  2. Strip off the domain portion of the request, leaving only the path and the query:

    Code Block
    
    /restaurants/haru-7?client=YOUR_CLIENT_ID
    
  3. Retrieve your private key, which is encoded in a modified Base64 for URLs, and sign the URL above using the HMAC-SHA1 algorithm. You may need to decode the Signing Key into its original binary format. In many cryptographic libraries, the resulting signature will be in binary format.
  4. Encode the resulting binary signature using the modified Base64 for URLs to convert this signature into something that can be passed within a URL.
  5. Attach this signature to the URL with a sigparameter:

    Code Block
    
    http://api.singleplatform.co/restaurants/haru-7?client=YOUR_CLIENT_ID&sig=BASE64_SIGNATURE
    

...