Differences

This shows you the differences between two versions of the page.

--- developers:remote_api:start [2015/06/10 19:35]
geojames [Remote API Calls]
+++ developers:remote_api:start [2015/07/10 17:47] (current)
geojames [Using a Sample Client File]
@@ Line 62: / Line 62: @@
 */</code>
+==== Sample Setup ====
+The initial steps would be to take one of the files within the remote samples directory found here in the file set:
+  /classes/api/_samples/
+and move it to where you would like that api call to be on your site.  Lets take the following file:
+   category.list_client.php
+You can move to a specific location on your site where you want all your api calls to sit.  You could rename that file to anything you like.  Let say I renamed the file and placed it here on my site:
+  http://example.com/remote_api_calls/get_categories.php
+Once there configure everything within the top of that file.  Lets assume the Geo software is installed in the following location and that I have not moved the XMLRPC.class.php file.  The configurations in that file would be:
+<code>
+//location of the XMLRPC.class.php file.  If calling the script from the _samples folder, leave this setting at the default.
+$xmlrpc_location = '../classes/rpc/XMLRPC.class.php';
+//url of geo_api.php file, something like "https://mysite.com/geo_api.php"
+//Note: recommended to use https for a secure connection, but if your server does not have SSL, you can use http instead.
+$website = "https://example.com/geo_api.php";
+//Site's API key.  You can find the site's API key on the home page in the admin.
+$api_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
+</code>
+You would pull the api key for the get_categories.php call (copied from "category.list_client.php") from the following configuration in the admin tool:
+  SITE SETUP > REMOTE API SECURITY KEYS > core.category.list
+And you would paste that key directly into that file where the "x's" are above.  That should be all the configurations in that file for that call.  If all calls are in the same location the paths should be the same.  Only the api key should change for each as each remote is different.  The core.category.list call happens to require "parent" to be passed into it.  That would be the parent category id of the subcategories to get.  So given the above urls the call to get the main categories would be:
+  http://example.com/remote_api_calls/get_categories.php?parent=0
+Each call requires it's own data and supplies it's own data in the response.  You'll need to get to know each to create a call for each.
 ===== Calls Created by Addons =====
 Note that you can create a new API call, inside of an addon.  As long as that addon is installed and enabled, you will be able to use the API call.

Geodesic Solutions Community Wiki

User Tools

Site Tools

Differences

Page Tools