api.pinmaps.netPinmaps.net Developers API and Documentation

-- Pinmaps API v1.0 Ext Urls ! Pinmaps Web Site ! Pinmaps Support ! Sample Maps Getting Started About What you need Map API Methods Introduction Get Map Get Maps Collection Create Map Update Map Delete Map Get Maps Count Map Points API Methods Introduction Get Map Point Get Map Points Collection Create Map Point Update Map Point Delete Map Point Get Map Points Count API Validation Validate Credentials Validate Developer Validate User API Response Codes Response Codes Code Samples C# Application Pinmaps.net API About Pinmaps.net is an online service that lets individuals easily search, save, share and quickly access their favorite locations on a map. Pinmaps.net allows you to create maps where you can add map points (push pins) to it. What makes this service stand out from other services is that you can save each map point with its own zoom level and map type . We suggest that you get familiar with the Pinmaps.net service and understand the concepts behing it before attempting to use the API. What you need In order to interact with the Pinmaps API you need to get a developer's API key and a user's API key . Every single call to the API requires four main credentials: DeveloperApiLogin, DeveloperApiKey, Username, and UserApiKey . Obtaining these four API Credentials is a three step process: You have to signup for the Pinmaps.net service You have to register as a Pinmaps.net Developer You need to obtain your user's API key Your Developer's API key will allow you to interact with your own pinmaps account as well as to make calls to the Pinmaps API on behalf of other users . If you want to make API calls on behalf of other users you need to ask them for their user's API key. Maps API Methods Introduction A map is a large area such as a city , a state , or a country that can hold many map points . You can create several maps with lots of map points to suit your needs. Important: your map is like a container for your map points (push pins) See Sample Maps GET v1/map This method returns a single map object by map ID . The result does not include the map points . Request URL http://api.pinmaps.net/v1/map?id={id}&apiLogin={apiLogin}&developerKey={developerKey}&userName={userName}&userKey={userKey} Parameters apiLogin required Developer's API login name developerKey required Developer's API Key userName required The username of the map owner userKey required The user's API key of the map owner id required The id of the map you want to retrieve Json Response {"MapID":2444, "MapName":"USA Airports", "Latitude":"38.06539235133249", "Longitude":"-96.10839844375", "ZoomLevel":"5", "MapType":"G_PHYSICAL_MAP", "MapOwner":"PinUser", "CreatedOn":"2013-03-15T14:20:52.993", "ModifiedOn":"2013-03-15T14:20:52.993", "IsShared":false, "MapLogo":"pinmaps_logo_trans.png", "RssUrl":"", "FitToBounds":true, "IconZomIn":true, "Overlays":"", "Icon":{"IconID":1, "IconName":"dot-red.png", "IconShadow":"msmarker_shadow.png", "IconWidth":"32", "IconHeight":"32", "ShadowWidth":"59", "ShadowHeight":"32"} } GET v1/maps This method returns a collection of maps objects by username . The list does not include the map points . Request URL http://api.pinmaps.net/v1/maps?apiLogin={apiLogin}&developerKey={developerKey}&userName={userName}&userKey={userKey} Parameters apiLogin required Developer's API login name developerKey required Developer's API Key userName required The username of the map owner userKey required The user's API key of the map owner Json Response [{"MapID":2457, "MapName":"USA Customers", "Latitude":"38.06539235133249", "Longitude":"-96.10839844375", "ZoomLevel":"5", "MapType":"G_NORMAL_MAP", "MapOwner":"PinUser", "CreatedOn":"2013-03-15T21:21:56.6", "ModifiedOn":"2013-03-15T21:21:56.6", "IsShared":false, "MapLogo":"pinmaps_logo_trans.png", "RssUrl":"", "FitToBounds":true, "IconZomIn":true, "Overlays":"", "Icon":{"IconID":1, "IconName":"dot-red.png", "IconShadow":"msmarker_shadow.png", "IconWidth":"32", "IconHeight":"32", "ShadowWidth":"59", "ShadowHeight":"32"} },{"MapID":2444, "MapName":"USA Airports", "Latitude":"38.06539235133249", "Longitude":"-96.10839844375", "ZoomLevel":"5", "MapType":"G_PHYSICAL_MAP", "MapOwner":"PinUser", "CreatedOn":"2013-03-15T14:20:52.993", "ModifiedOn":"2013-03-15T14:20:52.993", "IsShared":false,"MapLogo":"pinmaps_logo_trans.png", "RssUrl":"", "FitToBounds":true, "IconZomIn":true, "Overlays":"", "Icon":{"IconID":1, "IconName":"dot-red.png", "IconShadow":"msmarker_shadow.png", "IconWidth":"32", "IconHeight":"32", "ShadowWidth":"59", "ShadowHeight":"32"} }] POST v1/map/create This method creates a single map on the selected MapZone and returns the created map object Post format: json Resource URL http://api.pinmaps.net/v1/map/create.json Parameters DeveloperApiLogin required Developer's API login name DeveloperApiKey required Developer's API Key UserName required The username of the map owner UserApiKey required The user's API key of the map owner MapName required Name of the map MapType optional The types of maps you can display. Use only any of these values: ROADMAP, SATELLITE, HYBRID, TERRAIN If not value or wrong value is supplied a ROADMAP will be used. Map Types Definitions : ROADMAP : displays the default road map view SATELLITE : displays Google Earth satellite images HYBRID : displays a mixture of normal and satellite views TERRAIN : displays a physical map based on terrain information. Json Response {"MapID":2463, "MapName":"USA Airports", "Latitude":"38.06539235133249", "Longitude":"-96.10839844375", "ZoomLevel":"5", "MapType":"G_NORMAL_MAP", "MapOwner":"PinUser", "CreatedOn":"2013-03-26T15:46:31.453", "ModifiedOn":null, "IsShared":false, "MapLogo":"pinmaps_logo_trans.png", "RssUrl":"", "FitToBounds":true, "IconZomIn":true, "Overlays":"", "Icon":{"IconID":1, "IconName":"dot-red.png", "IconShadow":"msmarker_shadow.png", "IconWidth":"32", "IconHeight":"32", "ShadowWidth":"59", "ShadowHeight":"32"} } PUT v1/map/update This method updates a single map and returns the updated map object Put format: json Resource URL http://api.pinmaps.net/v1/map/update.json Parameters DeveloperApiLogin required Developer's API login name DeveloperApiKey required Developer's API Key UserName required The username of the map owner UserApiKey required The user's API key of the map owner MapID required The id of the map you want to update MapName required Name of the map (current or new) MapType optional The types of maps you can display. Use only any of these values: ROADMAP, SATELLITE, HYBRID, TERRAIN If not value or wrong value is supplied a ROADMAP will be used. Json Response { "MapID":2444, "MapName":"USA Airports", "Latitude":"38.06539235133249", "Longitude":"-96.10839844375", "ZoomLevel":"5", "MapType":"G_PHYSICAL_MAP", "MapOwner":"PinUser", "CreatedOn":"2013-03-15T14:20:52.993", "ModifiedOn":"2013-03-17T21:12:23.035", "IsShared":false, "MapLogo":"pinmaps_logo_trans.png", "RssUrl":"", "FitToBounds":true, "IconZomIn":true, "Overlays":"", "Icon":{ "IconID":1, "IconName":"dot-red.png", "IconShadow":"msmarker_shadow.png", "IconWidth":"32", "IconHeight":"32", "ShadowWidth":"59", "ShadowHeight":"32" } } DELETE v1/map/destroy This method deletes a single map object by map ID Delete format: json Resource URL http://api.pinmaps.net/v1/map/destroy.json Parameters DeveloperApiLogin required Developer's API login name DeveloperApiKey required Developer's API Key UserName required The username of the map owner UserApiKey required The user's API key of the map owner MapID required The id of the map you want to remove Json Response {"MapID":2463,"UserName":"PinUser","PinsCount":14} GET v1/maps/count This method returns the total maps count by username . Request URL http://api.pinmaps.net/v1/maps/count?apiLogin={apiLogin}&developerKey={developerKey}&userName={userName}&userKey={userKey} Parameters apilogin required Developer's API login name developer key required Developer's API Key username required The username of the map owner ...