Differences

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

--- perl_client_library [2011/01/04 21:53] – jay
+++ perl_client_library [2011/11/10 19:34] (current) – jay
@@ Line 15: / Line 15: @@
 SYNOPSIS
       use Lib4theFileAPI;
-      my $api = Lib4theFileAPI->new('https://4thefile.com/api_v1',$username,$apiKey);
+      my $api = Lib4theFileAPI->new(’https://4thefile.com/api_v1’,$username,$apiKey)
+           ││ die "invalid endpoint url or credentials";
+      $api->test_connect or die "failed api connection with error: ".$api->response->status_line;
       # list resources for collection ESuVkqZF that have tag "newtag"
@@ Line 36: / Line 38: @@
 INSTANCE METHODS
-    response();
+    response()
         returns an HTTP::Response object resulting from previous API call,
         especially useful if previous call returned undef indicating a
         problem
+    test_connect()
+        attempts a call to the resource_list API method and returns 1 if connection was successful and valid data
+        received. returns undef if connection failed (use response->status_line to see the error code returned
+        from the http connection), or returns 0 if the connection was successful but no valid xml was returned by
+        the server
     resource_list([$query])
@@ Line 88: / Line 96: @@
         does not delete resource from 4theFile.
-AUTHOR
-    created by: jay; Fri Nov 5 16:58:42 2010
-    last revised:
 </code>

4theFile Support Wiki