General API Requirements

Applications that use the SinglePlatform APIs must abide by all existing Terms of Service. Most importantly, you must correctly identify your requests.

...

http://menus.singleplatform.co/restaurantslocations/haru-7/menu?apiKey=YOUR_API_KEY_HERE

...

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/restaurantslocations/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
   /restaurantslocations/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/restaurantslocations/haru-7?client=YOUR_CLIENT_ID&sig=BASE64_SIGNATURE

...

Sample libraries are available for download if you need assistance generating valid URLs:

• Python
• Ruby
• PHP
• Java