MetaLocator offers a PaaS API that allows the development of custom applications using MetaLocator as the underlying location-services platform.  This service returns JSON formatted results based on user-supplied query parameters.  All query features of MetaLocator's customer-facing Interfaces are also available through this method.

View PaaS API Documentation

https://admin.metalocator.com/components/com_locator/assets/documents/api/classes/LocatorControllerAPI.html

PaaS API Introduction

All communication with MetaLocator's PaaS API requires the use of an API Key.  Only MetaLocator account holders with Platform Access can create API Keys.  For information on obtaining an API Key contact the Help Desk.

A basic call to the MetaLocator PaaS API looks like this:

https://code.metalocator.com/webapi/api/<method>?Itemid=X&apikey=Y&username=<yourusername>&password=<yourpassword>

Where X is the Interface ID number and Y is your API Key, your username is your MetaLocator user name and password is your MetaLocator password.  

A typical response looks like the below example.  The response differs based on the Interface requested and includes your custom fields and all Address Formats.

This sample JSON output shows a single location.  Output resulting in more than one location is formatted as an array of the object below.  Results are ordered according to requested query parameters.  

   {
      "html":"<h2 class=\"com_locator_title\" itemprop=\"name\"> <a class=\"collapse_list_hide\" href=\"javascript:void(0);\" onclick=\"javascript:load_content(3268);\">ATM Location<\/a><a class=\"collapse_list_reveal\" href=\"javascript:void(0);\" onclick=\"load_detail_page(3268);\">ATM Location<\/a><\/h2><span class=\"com_locator_distance\">Approximately 0.2 Miles from your location<\/span><br\/><span  itemprop=\"streetAddress\"  class=\"line_item address\">1290 Broadway<\/span><br\/> <span  itemprop=\"addressLocality\"  class=\"line_item city\">Denver<\/span>, <span  itemprop=\"addressRegion\"  class=\"line_item state\">CO<\/span> <span  class=\"line_item postalcode\">80203<\/span><br\/><span  itemprop=\"telephone\"  class=\"line_item phone\">123-123-4433<\/span><br\/>",
      "map":"<h2 class=\"com_locator_title\" itemprop=\"name\"> <a class=\"collapse_list_hide\" href=\"javascript:void(0);\" onclick=\"javascript:load_content(3268);\">ATM Location<\/a><a class=\"collapse_list_reveal\" href=\"javascript:void(0);\" onclick=\"load_detail_page(3268);\">ATM Location<\/a><\/h2><span class=\"com_locator_distance\">Approximately 0.2 Miles from your location<\/span><br\/><span  itemprop=\"streetAddress\"  class=\"line_item address\">1290 Broadway<\/span><br\/> <span  itemprop=\"addressLocality\"  class=\"line_item city\">Denver<\/span>, <span  itemprop=\"addressRegion\"  class=\"line_item state\">CO<\/span> <span  class=\"line_item postalcode\">80203<\/span><br\/><span  itemprop=\"telephone\"  class=\"line_item phone\">123-123-4433<\/span><br\/>",
      "detail":"<h2 class=\"com_locator_title\" itemprop=\"name\"> <a class=\"collapse_list_hide\" href=\"javascript:void(0);\" onclick=\"javascript:load_content(3268);\">ATM Location<\/a><a class=\"collapse_list_reveal\" href=\"javascript:void(0);\" onclick=\"load_detail_page(3268);\">ATM Location<\/a><\/h2><span class=\"com_locator_distance\">Approximately 0.2 Miles from your location<\/span><br\/><span  itemprop=\"streetAddress\"  class=\"line_item address\">1290 Broadway<\/span><br\/> <span  itemprop=\"addressLocality\"  class=\"line_item city\">Denver<\/span>, <span  itemprop=\"addressRegion\"  class=\"line_item state\">CO<\/span> <span  class=\"line_item postalcode\">80203<\/span><br\/><span  itemprop=\"telephone\"  class=\"line_item phone\">123-123-4433<\/span><br\/><div class=\"com_locator_fulltext\"> <p>This is a sample location detail page. In this area, you can provide <a href=\"http:\/\/www.metalocator.com\" target=\"_blank\">links<\/a>, descriptions, pictures or any other media needed to showcase your location. This information is entirely optional, but can serve as a great place to put location-specific information like store hours, detailed contact information or videos and pictures. MetaLocator.com allows most any HTML\/Javascript or CSS which provides full style control. <img src=\"http:\/\/demo.metalocator.com\/images\/metalocator\/images\/photodune-1363153-atm-xs.jpg\" alt=\"ATM Location\" align=\"right\"><\/p> <span class='st_sharethis_large' displayText='ShareThis'><\/span> <span class='st_facebook_large' displayText='Facebook'><\/span> <span class='st_twitter_large' displayText='Tweet'><\/span> <span class='st_linkedin_large' displayText='LinkedIn'><\/span> <span class='st_email_large' displayText='Email'><\/span> <script type=\"text\/javascript\">var switchTo5x=true;<\/script> <script type=\"text\/javascript\" src=\"http:\/\/w.sharethis.com\/button\/buttons.js\"><\/script> <script type=\"text\/javascript\">stLight.options({publisher: \"492113e4-2d0d-45c3-ae2f-7154e5770bab\"}); <\/script><\/div>",
      "id":"3268",
      "name":"ATM Location",
      "type":"",
      "description":"<p>This is a sample location detail page. In this area, you can provide <a href=\"http:\/\/www.metalocator.com\" target=\"_blank\">links<\/a>, descriptions, pictures or any other media needed to showcase your location. This information is entirely optional, but can serve as a great place to put location-specific information like store hours, detailed contact information or videos and pictures. MetaLocator.com allows most any HTML\/Javascript or CSS which provides full style control. <img src=\"http:\/\/demo.metalocator.com\/images\/metalocator\/images\/photodune-1363153-atm-xs.jpg\" alt=\"ATM Location\" align=\"right\"><\/p> <span class='st_sharethis_large' displayText='ShareThis'><\/span> <span class='st_facebook_large' displayText='Facebook'><\/span> <span class='st_twitter_large' displayText='Tweet'><\/span> <span class='st_linkedin_large' displayText='LinkedIn'><\/span> <span class='st_email_large' displayText='Email'><\/span> <script type=\"text\/javascript\">var switchTo5x=true;<\/script> <script type=\"text\/javascript\" src=\"http:\/\/w.sharethis.com\/button\/buttons.js\"><\/script> <script type=\"text\/javascript\">stLight.options({publisher: \"492113e4-2d0d-45c3-ae2f-7154e5770bab\"}); <\/script>",
      "published":"1",
      "user_id":"0",
      "geofailed":null,
      "address":"1290 Broadway",
      "address2":"",
      "city":"Denver",
      "state":"CO",
      "postalcode":"80203",
      "country":"United States",
      "date":"",
      "phone":"123-123-4433",
      "hours":"",
      "link":"",
      "email":"",
      "icon":"",
      "tld":"US",
      "image":"",
      "metadescription":"",
      "metakeywords":"",
      "language":"",
      "sourcefile":"us_chase_atms.csv",
      "lng":"-104.9872",
      "lat":"39.73657",
      "tag1":null,
      "tag2":null,
      "tag3":null,
      "publishstart":null,
      "publishend":null,
      "county":"",
      "isdirty":null,
      "lobbyhours":"{Mon|9:00-13:00}{Tue|15:00-16:15}{Wed|15:00-16:15}{Sat|C}",
      "bankservices":"Cashier Check, Check Cashing, Drive up accessible, Money Order, New Account Openings, Notary, Wheel Chair accessible",
      "driveuphours":"{Mon|9:00-13:00}{Tue|15:00-16:15}{Wed|15:00-16:15}{Sat|C}",
      "tellerlanguages":"Hindi, Farsi, Russian, Spanish",
      "fax":null,
      "startdate":null,
      "enddate":null,
      "distance":0.22506179748581,
      "marker":null,
      "marker_shadow":null,
      "marker_text":null,
      "fg_marker_color":null,
      "bg_marker_color":null,
      "marker_order":"3",
      "priority":null,
      "priority_name":"Vendor",
      "fulltext":"<p>This is a sample location detail page. In this area, you can provide <a href=\"http:\/\/www.metalocator.com\" target=\"_blank\">links<\/a>, descriptions, pictures or any other media needed to showcase your location. This information is entirely optional, but can serve as a great place to put location-specific information like store hours, detailed contact information or videos and pictures. MetaLocator.com allows most any HTML\/Javascript or CSS which provides full style control. <img src=\"http:\/\/demo.metalocator.com\/images\/metalocator\/images\/photodune-1363153-atm-xs.jpg\" alt=\"ATM Location\" align=\"right\"><\/p> <span class='st_sharethis_large' displayText='ShareThis'><\/span> <span class='st_facebook_large' displayText='Facebook'><\/span> <span class='st_twitter_large' displayText='Tweet'><\/span> <span class='st_linkedin_large' displayText='LinkedIn'><\/span> <span class='st_email_large' displayText='Email'><\/span> <script type=\"text\/javascript\">var switchTo5x=true;<\/script> <script type=\"text\/javascript\" src=\"http:\/\/w.sharethis.com\/button\/buttons.js\"><\/script> <script type=\"text\/javascript\">stLight.options({publisher: \"492113e4-2d0d-45c3-ae2f-7154e5770bab\"}); <\/script>",
      "number":1,
      "offset":0,
      "marker_options":{
         "map":"map",
         "position":"new google.maps.LatLng(39.73657,-104.9872);",
         "zIndex":"3"
      },
      "address_format":"<span  itemprop=\"streetAddress\"  class=\"line_item address\">1290 Broadway<\/span> <span  itemprop=\"addressLocality\"  class=\"line_item city\">Denver<\/span>, <span  itemprop=\"addressRegion\"  class=\"line_item state\">CO<\/span> <span  class=\"line_item postalcode\">80203<\/span>"
   },
Did this answer your question?