REST API
Partner Agreement Considerations
SinglePlatform's agreement with our partners requires all publishers to update SinglePlatform's data every 24 hours. To do this, our partners make use of our updatedSince parameter in our Search API (api.singleplatform.co/locations/search).
By passing in, as a search parameter, the updatedSince date tag of the previous day, you will be returned a list of all SinglePlatform IDs that have been added or updated in that time period.
- If the SinglePlatform ID returned to you has already been mapped on your side, then we require that you re-ingest and update the existing data for that location and its menu.
- If the SinglePlatform ID returned to you has not been mapped on your side, then we require that you map it to an existing location in your database and ingest the location/menu data accordingly.
- If the SinglePlatform ID returned to you has not been mapped on your side, and you are unable to find a match in your database, then we require that you add the location to your database and ingest the location/menu data accordingly.
Matt Doumar (mdoumar@singleplatform.com), our product lead, will be available to work with our partners' dev teams to ensure the process of matching / updating / adding locations is as straightforward as possible and in compliance with SinglePlatform's partner agreement.
| Warning |
|---|
This documentation is obsolete. Please see updated documentation at http://docs.singleplatform.com/spv2/rest-api/ |
REST API
General API Information
Content Types
...
q: The query string. A free-form query, it searches in the following ways (NOTE: blank queries return nothing):- by phone number in one of these forms: 10 sequential digits; with dash or period separators (ex: XXX-XXX-XXXX)
- by zip code in one of these forms: 5 digit zip, 9 digit zip with dash (ex. 10001-4356)
- by name of location
page: The page number. A zero-based value. The default value is 0 for the first page.count: The number of results per page. The default value is 20, and the maximum value is 1000.updatedSince: Filter the results to list only those locations updated since the specified date and time.- Format (date only): YEARYYYY-MONTHMM-DAYDD
- Example:
- 2012?updatedSince=2013-01-05
- Format (date & time): YYYY-MM-DDTHH%3AMM%3ASS
- Example:
- ?updatedSince=2013-01-05T09%3A10%3A00
- ?updatedSince=2013-01-05T09%3A10%3A00
URI Examples:
The following two example URIs are equivalent and return the first 20 of the available locations as the 0th page of locations.
...
The following example returns the first 20 of the locations updated since January 18, 2012 2013 at 2:03 pm as the 0th page of locations.
| Code Block |
|---|
/locations/search?updatedSince=20122013-01-1818T14%3A03%3A00 |
Response
The JSON response contains the following information:
...
In the URI, LOCATION should be replaced by the ID of the location. For example, the ID for Haru might be haru-7 and the URI would be /locations/haru-7/
GET
Request
Headers:
Accept: takes one of:application/json
...