Proximity Match Web to Mobile Developer API
This site is a reference for developers interested in the Proximity Match Mobile Platform into their website. Although we are still in beta many of the API methods necessary for development are present and have been time tested to be working properly. - Enjoy!
Utilizing the Proximity Match Mobile Platform APIs (PMAPI) developers can mobilize their web-based services, site content and widgets in new and interesting ways. Through the Proximity Match Mobile Platform you are in complete control of how and when information is sent to your users’ mobile phones. Our platform enables developer to deploy news, pictures, videos (coming soon), alerts, polls, advertisements and interactive widgets in real time. Through the Proximity Match Analytics Engine developer also have access to their users mobile activity to improve your systems performance and users' experience.
Formats
Each webservice in the Proximity Match Mobile API accepts results in XML & JSON. Additional formats will be forthcoming.
Authentication
Most webservices in the Proximity Match Mobile API require an authentication token to be passed. Within the documentation each service states whether it requires authentication or not. Proximity Match does not have separate developer keys for accessing API methods that require authentication.
Currently, the API supports one method of authentication:
- Required Parameters - these parameters must be passed to every webservice call. Calls that do not contain the proper parameters will be return an error message. To view Proximity Match Error Message please go here.
- UID - The Stored User ID "authpass" parameters to every , with the user name and password, respectively.
|
|
ATTN Mobile Application Developers:
Plugging into the Proximity Match Mobile Platform to manage data to and from your applications will drastically shorten your time to market!
Once you hook into our API your application will have access to over 50+ different data providers, social community web services, 3rd party software and mobile advertising engines.
Read more.
|
Metering
Calls to any webservice that requires authentication are metered. A particular set of messages sent through one method to one user from your system is limited to 100 calls per hour. Calls made to external systems are unlimited and subject to the 3rd party's terms and services. Calls that exceed the metering cap will receive a error. Please see our
Error Codes for more information.
Caching
Proximity Match at times will cache the responses to and from some web services and user handsets to improve performance and users experience. An example of this is current and last location and last searched directions. Dependant upon the frequency a users accesses our system will determine the amount of time our system keeps the information. Any web service that does not require authentication may be cached. Currently, any webservice that requires authentication is not cached.
Throttling
Proximity Match's Mobile Platform closely monitors messages sent through our system. Our platform does this to improve overall system performance and your users mobile experience. Typically a users experience is not affected by data throttling, however dependent upon the phone and its network a user might experience wait time or lag when interacting with their data.
Media
Currently the Proximity Match Mobile API (PMAPI) has the ability to send and distribute pictures to users subscribed to photo sharing services. Each image regardless if you send or we receive must contain the full url of its location. Display sizes will be chosen dependent upon the users' phone limitations. Images are not metered. Support for full streaming video is planned for 1st Quarter 2009.
API Access Point
All calls to the Proximity Match Mobile Platform API (PMAPI) will be made through following URL.
http://api.proximitymatch.com
Required Parameters
These parameters myst ALWAYS be present when calling the Proximity Match Mobile API.