Difference between revisions of "REST"

From aMember Pro Documentation
Jump to: navigation, search
Line 28: Line 28:
 
;_filter[''FIELDNAME'']  
 
;_filter[''FIELDNAME'']  
 
:Adds a WHERE condition for ''FIELDNAME''. If search value contains ''%'' it is considered as pattern for SQL LIKE expression, else SQL = condition is used. If several filters provided, it will be concatenated in SQL AND expression.
 
:Adds a WHERE condition for ''FIELDNAME''. If search value contains ''%'' it is considered as pattern for SQL LIKE expression, else SQL = condition is used. If several filters provided, it will be concatenated in SQL AND expression.
<br>
 
  
;_nested[]
+
;_nested[]  
:Requests to include nested records into dataset. For example, if you are accessing users database via REST, you can do it like this: ''http://example.com/amember/api/users?_key=''<u>''APIKEY''</u>&format=xml&_nested[]=invoices&_nested=access This will include user's invoices and access records into output. List of available nested tables is unique to each record type.
+
:Requests to include nested records into dataset. For example, if you are accessing users database via REST, you can do it like this: ''http://example.com/amember/api/users?_key=''<u>''APIKEY''</u>&amp;format=xml&amp;_nested[]=invoices&amp;_nested=access This will include user's invoices and access records into output. List of available nested tables is unique to each record type.
 +
 
 +
== Adding users via Web API<br>  ==

Revision as of 08:46, 18 June 2012

Contents

aMember Pro Web API (REST)

Since 4.2.6 release aMember Pro provides web api based on REST principles. It allows to fetch and submit information about users, products and payments. It is easy to extend and use, and we expect that list of interfaces will be extended soon.

Enabling of REST API

Go to aMember CP -> Setup -> Plugins, and enable "api" module. If your aMember installation has no "api" module available, you can get it for free in the members area

Once the module is enabled, scroll down and find an admin menu item Remote Api Permissions. Click New Record. You will see a form to fill - your comment about the access key, a generated access key itself, and list of checkboxes describing what system calls is available for given access key. Check necessary calls and Save.

Fetching list of users via Web API

To try it out, open in your browser http://example.com/amember/api/users?_key=APIKEY

You will see first 20 user records in JSON format and total number of users in _total variable

You can pass additional parameters to control output:

_format
Either: json (default), xml or serialize
_count
Number of records per page (default: 20, max: 100)
_page
Page of output (default: 0 - the first page)
_filter[FIELDNAME]
Adds a WHERE condition for FIELDNAME. If search value contains % it is considered as pattern for SQL LIKE expression, else SQL = condition is used. If several filters provided, it will be concatenated in SQL AND expression.
_nested[]
Requests to include nested records into dataset. For example, if you are accessing users database via REST, you can do it like this: http://example.com/amember/api/users?_key=APIKEY&format=xml&_nested[]=invoices&_nested=access This will include user's invoices and access records into output. List of available nested tables is unique to each record type.

Adding users via Web API