|
|
| (52 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| − | The RadioReference.com Application Programming Interface provides a set of services for Webmasters and Application Developers to integrate data from radioreference.com into their own products. There are three core components of the RadioReference.com API: | + | == The RadioReference Database Web Service == |
| | | | |
| − | * SOAP Based Web service for RadioReference Database Data
| + | The RadioReference Database Web Service is an SOAP (Simple Object Application Protocol) XML based Web service which allows integration of applications and other Web services using RadioReference Database data. The API is completely free to use by developers, however and API key is required, and the end users must have an active premium subscription to access the data through the API. |
| − | * Javascript Remote Render Service for RadioReference Database Data
| |
| − | * XML/JSON based Web service for the live audio feed catalog
| |
| | | | |
| − | = The RadioReference SOAP based XML Web service =
| + | Application developers can provide users complete access to RadioReference.com data through their own applications. From software applications to automatically program a user's scanner based on their location, to alternative display mechanisms of RadioReference data, the SOAP API provides all the methods needed to develop a robust and exciting set applications. |
| | | | |
| − | Application developers have the opportunity to provide users complete access to RadioReference.com data through their own applications. From software applications to automatically program a user's scanner based on their location, to alternative display mechanisms of RadioReference data, the SOAP API provides all the methods needed to develop a robust and exciting set applications.
| + | The Radioreference.com Database Web Service service is currently documented using the following WSDL: |
| | | | |
| − | The radioreference.com SOAP based XML Web service is currently documented using the following WSDL:
| + | * https://api.radioreference.com/soap2/?wsdl&v=latest |
| | + | <br /> |
| | + | Documentation and endpoint version information can be found here: |
| | | | |
| − | http://api.radioreference.com/soap2/?wsdl&v=latest
| + | * [[RadioReference.com_Web_Service3.1|SOAP Web Service Documentation]] |
| − | | + | <br /> |
| − | Further details can be found at:
| + | A list of applications that support the Web service and further details can be found at: |
| | | | |
| | [[RadioReference.com_Web_Service]]. | | [[RadioReference.com_Web_Service]]. |
| | | | |
| − | = The RadioReference Javascript Remote Render Display Service =
| + | An API key is required to utilize the Web service. If you wish to apply for an API key to get started developing applications to use RadioReference data, '''please submit a support request to us at support@radioreference.com''' and we will work with you to get an API key issued. |
| − | | |
| − | The RadioReference Javascript remote render service allows webmaster and web page developers to integrate data from the radioreference.com database into their own Web pages.
| |
| − | | |
| − | == Steps for using the Javascript remote render service ==
| |
| − | | |
| − | 1. Apply for a domainKey at the following page on your account settings page:
| |
| − | | |
| − | * http://www.radioreference.com/apps/account/?tab=api
| |
| − | | |
| − | 2. Wait for your domainKey to be approved by the administration staff. You will receive an email to your email address on record when approved.
| |
| − | | |
| − | 3. Add the necessary javascript code snippet and domainKey to your page for the data you want to remotely render.
| |
| − | | |
| − | == Data available for remote rendering ==
| |
| − | | |
| − | === Frequency Subcategory ===
| |
| − | | |
| − | You can display a frequency subcategory on a Web page by adding the following code to the page:
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&scid=SUBCAT_ID">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | * DOMAIN_KEY = Your uniquely assigned and active domain key
| |
| − | * SUBCAT_ID = The unique radioreference.com subcategory ID. This can be found by clicking the subcategory additional details icon for a subcategory. See below:
| |
| − | | |
| − | [[Image:Scid_api_1.gif|250px|Subcategory Additional Details]]
| |
| − | [[Image:Scid_api_2.gif|250px|Subcategory Unique ID (SUBCAT_ID)]]
| |
| − | | |
| − | For example, to display the Comal County Fire SO frequency subcategory on a page, you would add the following code:
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&scid=195">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | The following would be displayed on the Web page where the code was inserted:
| |
| − | | |
| − | [[Image:Scid_api_result.gif|border|400px]]
| |
| − | | |
| − | === Trunked Radio System Information ===
| |
| − | | |
| − | You can display a trunking system's general information on a Web page by adding the following code to the page:
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sid=SID">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | * DOMAIN_KEY = Your uniquely assigned and active domain key
| |
| − | * SID = The unique radioreference.com trunked system system identifier. This can be found by viewing the URL for the trunked system. See below:
| |
| − | | |
| − | [[Image:Sid_api_1.gif|250px|Trunked System SID]]
| |
| − | | |
| − | For example, to display the Bexar County / San Antonio EDACS system's general information, you would include the following code on your page:
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&sid=1434">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | The following would be displayed on the Web page where the code was inserted:
| |
| − | | |
| − | [[Image:Sid_api_result.gif|border|250px]]
| |
| − | | |
| − | === Talkgroup Category ===
| |
| − | | |
| − | You can display a talkgroup category's talkgroups on a Web page by adding the following code to the page:
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&tgCid=TGCAT_ID">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | * DOMAIN_KEY = Your uniquely assigned and active domain key
| |
| − | * TGCAT_ID = The unique radioreference.com talkgroup category ID. This can be found by clicking the talkgroup category additional details icon. See below:
| |
| − | | |
| − | | |
| − | [[Image:TgCid_api_1.gif|250px|Talkgroup Category Additional Details]]
| |
| − | [[Image:TgCid_api_2.gif|250px|Talkgroup Category Unique ID (TGCAT_ID)]]
| |
| − | | |
| − | For example, to display the City of Arlington's Fire Department Talkgroups from the Arlington Trunked System, you would add the following code:
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&tgCid=2">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | The following would be displayed on the Web page where the code was inserted:
| |
| − | | |
| − | [[Image:TgCid_api_result.gif|border|400px]]
| |
| − | | |
| − | === Trunked System Complete Talkgroup List ===
| |
| − | | |
| − | You can display all talkgroups for a trunking system on a Web page by adding the following code to the page:
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key=DOMAIN_KEY&sidalltg=SID">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | * DOMAIN_KEY = Your uniquely assigned and active domain key
| |
| − | * SID = The unique radioreference.com trunked system system identifier. This can be found by viewing the URL for the trunked system.
| |
| − | | |
| − | [[Image:Sidalltg_api_1.gif|300px|Trunked System SID]]
| |
| − | | |
| − | For example, to display all talkgroups for the Parker County TX Trunking system , you would add the following code to your page:
| |
| − | | |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&sidalltg=5636">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | The following would be displayed on the Web page where the code was inserted:
| |
| − | | |
| − | [[Image:Sidalltg_api_result.gif|border|400px]]
| |
| − | | |
| − | === Trunked System Site with Frequencies===
| |
| − | | |
| − | You can display a individual trunked system site with frequencies on a Web page by adding the following code to the page:
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key= DOMAIN_KEY&siteId=SITE_ID">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | * DOMAIN_KEY = Your uniquely assigned and active domain key
| |
| − | * SITE_ID = The unique radioreference.com siteId. This can be found by clicking the site description link for a trunked system site. See below:
| |
| − | | |
| − | [[Image:Site_api_1.gif|250px|Site Additional Details Link]]
| |
| − | [[Image:Site_api_2.gif|225px|Site Unique ID (SITE_ID)]]
| |
| − | | |
| − | For example, to display the trunked system site for the Irving TX Public Safety Trunking System, the following code would be used:
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&siteId=10500">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | The following would be displayed on the Web page where the code was inserted:
| |
| − | | |
| − | [[Image:Site_api_result.gif|border|500px]]
| |
| − | | |
| − | === All Trunked System Sites ===
| |
| − | | |
| − | You can display all trunked system sites with frequencies on a Web page by adding the following code to the page:
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key= DOMAIN_KEY&sites=SID">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| − | | |
| − | * DOMAIN_KEY = Your uniquely assigned and active domain key
| |
| − | * SID = The unique radioreference.com trunked system system identifier. This can be found by viewing the URL for the trunked system.
| |
| − | | |
| − | For example, to display all trunked system sites for the San Antonio TX Public Safety Trunking System, the following code would be used:
| |
| − | <pre>
| |
| − | <nowiki>
| |
| − | <script language="JavaScript" src="http://api.radioreference.com/js/?key=12345678&sites=1434">
| |
| − | </script>
| |
| − | </nowiki>
| |
| − | </pre>
| |
| | | | |
| − | [[Category:FAQ]] | + | [[Category:Database FAQ]] |