i4a API Wiki - User contributions [en]

Authentication

2017-04-14T17:52:22Z

Laura:

== About ==
this article discusses how to perform remote authentication using your i4a website and data from a remote website or program. It's important to note that the remote process need NOT be a website, it could be an application, even a mobile app or mobile website.

== Requirements ==
* SOAP. The authentication protocol currently utilizes SOAP. This is the mechanism that the i4a website uses to provide authentication. This is a common protocol, with broad support and a lot of online resources that can provide both education as well as support for this.
* You can manage your API login and Token values by logging into your site admin and selecing 'API Settings' from the Admin menu. On this screen, you can define a username/password to use with your API. This username will NOT count against your admin seats, however it can only be used to authenticate through the API and cannot be used as a regular admin acct. Your site should already have a token defined for it, but if you wish you can generate a new one. Please be aware that any changes to these values will require that any existing code that uses the i4a API must be updated with your changed values.

== Use ==
* To access the authentication routine, your vendor must first authenticate themselves. You could think of this as an initial handshake so that both parties can then begin further communication.

[[category:Information]][[category:HowTo]]

Additional Examples

2016-11-08T19:20:08Z

Laura:

==Filtering on Member Type and Expiration Date using the API==

The i4a system can be configured to use the Individual Database Model or the Organizational Database Model. The simplest way to determine the database model is to check for the presence of Manage Organizations on the Membership dropdown menu in the i4a system. If it is present, the system is configured to use the Organizational Database Model, and if it is absent, it is using the Individual Database Model.

===Selecting a Data Source to use with the API===

Here are the two main views that can be used with the API. Contact i4a for support if you are not able to get what you need using these views, or from the tables in the examples provided.

* '''ams_contactinformation_membertype''' - Includes the "membertype" field which contains the record's Member Type if it is populated. The "paidthru" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the individual database model only.'''''

* '''ams_contactinformation_corptype''' - Includes the "corptype" field which contains the record's Member Type if it is populated. The "corpexpiration" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the organizational database model only.'''''

Below are some examples specific to each database model:

===Individual Database Model Examples===

The examples below uses the view ams_contactinformation_membertype. This view should only be used with the i4a Individual Database Model:

* /i4a/api/json/view.ams_contactinformation_membertype/membertype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular. Current and expired members would be returned in this example.

* /i4a/api/json/view.ams_contactinformation_membertype/membertype is not null/<authkey> - Returns a json packet that contains all matching records that have a member type. Current and expired members would be returned in this example.

===Organizational Database Model Examples===

The following example uses the view ams_contactinformation_corptype. This view should only be used with the i4a Organizational Database Model.

* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.

'''[[I4A api guide]]'''

[[Category:api]]

Additional Examples

2016-11-08T19:19:18Z

Laura: /* Organizational Database Model Examples */

Additional Examples

2016-11-08T19:17:30Z

Laura: /* Organizational Database Model Examples */

Additional Examples

2016-11-08T19:17:17Z

Laura: /* Organizational Database Model Examples */

I4A API Guide v1 Deprecated March 31, 2024

2016-11-08T19:15:56Z

Laura: /* API Examples */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations API. The api makes use of the SOAP protocol for authentication only. All other aspects of the API use REST.

Currently the API determines if the user wishes to retrieve an Object or a Collection based on the plurality of the object. So requesting: /membership.contact/ and /membership.contacts/ will access the object and the collection respectively. There is also a /view.XXX/ method that will allow you to retrieve a table or view directly, however that mode is and always will be READONLY.

== Security ==
To access any of the API functionality, you must first authenticate.
Information is available on the [[API Settings]] page on how to obtain the values needed to authenticate and update them if need be.

Authentication can come in one of 2 forms:
=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>http://<site.com>/i4a/api/authenticate/<USER>/<PASSWORD>/<TOKEN></pre>

You will get back a json packet which will contain your authKey which you can then use to make calls to the API.

=== Soap Authentication ===
This method is deprecated and should no longer be used for new projects.
* Use the SOAP method authenticateAdmin that is available from the SOAP WSDL located at:
** <pre>http://<site.com>/i4a/utilities/authenticate.cfc?wsdl</pre>

The authenticateAdmin takes 3 parameters, they are:
* Username: Must be an administrator username capable of logging onto the site admin.
* Password: the password for the user.
* Token: The Token is specific to each website. It will be made available in your site admin.

== Syntax ==
Calling the API involves building a URL that the API engine can decode. The API engine uses the REST method. REST allows you to utilize GET, POST and DELETE methods. Currently the i4a api only supports GET, which means the API is read-only at this time.

To access the API you can test it in your browser. First you should login to your admin, then direct your page to:

<pre>http://site.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>http://site.com/i4a/api/json/membership.contacts/city like Chicago/<authkey></pre>

The REST command is broken up into several parts, they are from left-right

* <code>http://site.com/i4a/api/</code> - this is the base url that every api call will have in common
* /json/ This tells the processor what format to return data in. The options here are Json, XML and WDDX. Json is the fastest format and also more common when using AJAX. For more information see [[api_return_format|API Return Format]]
* /membership.contact/ - This tells the processor what object or table to access.
* /city like Chicago/ - This allows you to filter your results.

=== Filtering ===
Some examples:

* /firstname=don/ - returns records that match firstname=don
* /City Like Chicago/ - returns records where the city field starts with Chicago
* /City CONTAINS CAN/ - finds records where the city field contains the string 'CAN'
* /logincount > 500 / (Need to test this
* /NULL/ - For querying a collection of records, this would allow for NO filter. This is required because simply leaving the filter empty results in 2 // and the 2nd / is removed by apache during the processing.

== API Objects ==

== API Examples ==

* /i4a/api/json/membership.contact/24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/xml/membership.contact/24228/<authkey> - returns an xml packet for contact record ID = 24228
* /i4a/api/wddx/membership.contact/24228/<authkey> - Returns a WDDX packet for contct record ID = 24228
The above examples are only relevent when referencing I4a objects. When interacting with views as below, you must always specify the name/value pair.

* /i4a/api/json/view.ams_contactinformation/id=24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/json/view.ams_contactinformation/lastname like L/<authkey> - Returns a json packet that would contain all matching records where lastname started with the letter L
* /i4a/api/json/view.ams_contactinformation/lastname Like L:isActive=1/<authkey> - Same as above, but further filters by isActive = 1
* /i4a/api/json/membership.contacts/<authkey> - returns all records from the table related to the ORM object com.om.collections.membership.contacts.
* /i4a/api/json/view.ams_contact/<authkey> - returns the same recordset as the example above, but interacts directly with the table itself.

'''[[Additional Examples]]'''

[[Category:api]]

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP Example]]
* [[i4a api Ajax Example|AJax Example]]

== Testing the API ==
Testing the API and inspecting the data returned is very easily achieved with any modern browser. It is worth noting that by default, only Firefox will display XML (if the header is set to text/xml) in a readable format. It is possible however in both Google Chrome and Safari to view the xml data in a user-friendly format by going into the developer tools for the browsers. For a better experience however it is recommended you install the following add-ons to each browser for a better experience:

=== Google Chrome ===
* https://chrome.google.com/extensions/detail/mfnjijpckfecpgchobgcfndicenjldoe - will display json data in a user-friendly format. Note: This is a great extension and displays json in a very good format, but it appears when viewing XML with the plugin below this plugin seems to insert some data at the top of the page. The xml viewer still works fine and rest assured this information is not IN the XML packet, but rather added in after by your browser and this plugin.
* https://chrome.google.com/extensions/detail/gbammbheopgpmaagmckhpjbfgdfkpadb - will display XML and WDDX in a friendly format directly in your browser page.

=== Firefox ===
* https://addons.mozilla.org/en-US/firefox/addon/10869 - will display json data in a user-friendly format

=== Safari ===
At this time there appears to be no plugins for Safari that can aid in viewing the data formats, it's recommended you use either Chrome or Firefox if you are going to be interacting with the API from the browser.

== Links ==
* http://en.wikipedia.org/wiki/Representational_State_Transfer Wikipedia article on REST
* http://en.wikipedia.org/wiki/SOAP - Wikipedia Article on SOAP protocol

[[Category:api]]

I4A API Guide v1 Deprecated March 31, 2024

2016-11-08T19:15:29Z

Laura: /* API Examples */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations API. The api makes use of the SOAP protocol for authentication only. All other aspects of the API use REST.

Currently the API determines if the user wishes to retrieve an Object or a Collection based on the plurality of the object. So requesting: /membership.contact/ and /membership.contacts/ will access the object and the collection respectively. There is also a /view.XXX/ method that will allow you to retrieve a table or view directly, however that mode is and always will be READONLY.

== Security ==
To access any of the API functionality, you must first authenticate.
Information is available on the [[API Settings]] page on how to obtain the values needed to authenticate and update them if need be.

Authentication can come in one of 2 forms:
=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>http://<site.com>/i4a/api/authenticate/<USER>/<PASSWORD>/<TOKEN></pre>

You will get back a json packet which will contain your authKey which you can then use to make calls to the API.

=== Soap Authentication ===
This method is deprecated and should no longer be used for new projects.
* Use the SOAP method authenticateAdmin that is available from the SOAP WSDL located at:
** <pre>http://<site.com>/i4a/utilities/authenticate.cfc?wsdl</pre>

The authenticateAdmin takes 3 parameters, they are:
* Username: Must be an administrator username capable of logging onto the site admin.
* Password: the password for the user.
* Token: The Token is specific to each website. It will be made available in your site admin.

== Syntax ==
Calling the API involves building a URL that the API engine can decode. The API engine uses the REST method. REST allows you to utilize GET, POST and DELETE methods. Currently the i4a api only supports GET, which means the API is read-only at this time.

To access the API you can test it in your browser. First you should login to your admin, then direct your page to:

<pre>http://site.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>http://site.com/i4a/api/json/membership.contacts/city like Chicago/<authkey></pre>

The REST command is broken up into several parts, they are from left-right

* <code>http://site.com/i4a/api/</code> - this is the base url that every api call will have in common
* /json/ This tells the processor what format to return data in. The options here are Json, XML and WDDX. Json is the fastest format and also more common when using AJAX. For more information see [[api_return_format|API Return Format]]
* /membership.contact/ - This tells the processor what object or table to access.
* /city like Chicago/ - This allows you to filter your results.

=== Filtering ===
Some examples:

* /firstname=don/ - returns records that match firstname=don
* /City Like Chicago/ - returns records where the city field starts with Chicago
* /City CONTAINS CAN/ - finds records where the city field contains the string 'CAN'
* /logincount > 500 / (Need to test this
* /NULL/ - For querying a collection of records, this would allow for NO filter. This is required because simply leaving the filter empty results in 2 // and the 2nd / is removed by apache during the processing.

== API Objects ==

== API Examples ==

* /i4a/api/json/membership.contact/24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/xml/membership.contact/24228/<authkey> - returns an xml packet for contact record ID = 24228
* /i4a/api/wddx/membership.contact/24228/<authkey> - Returns a WDDX packet for contct record ID = 24228
The above examples are only relevent when referencing I4a objects. When interacting with views as below, you must always specify the name/value pair.

* /i4a/api/json/view.ams_contactinformation/id=24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/json/view.ams_contactinformation/lastname like L/<authkey> - Returns a json packet that would contain all matching records where lastname started with the letter L
* /i4a/api/json/view.ams_contactinformation/lastname Like L:isActive=1/<authkey> - Same as above, but further filters by isActive = 1
* /i4a/api/json/membership.contacts/<authkey> - returns all records from the table related to the ORM object com.om.collections.membership.contacts.
* /i4a/api/json/view.ams_contact/<authkey> - returns the same recordset as the example above, but interacts directly with the table itself.

[[Additional Examples]]

[[Category:api]]

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP Example]]
* [[i4a api Ajax Example|AJax Example]]

== Testing the API ==
Testing the API and inspecting the data returned is very easily achieved with any modern browser. It is worth noting that by default, only Firefox will display XML (if the header is set to text/xml) in a readable format. It is possible however in both Google Chrome and Safari to view the xml data in a user-friendly format by going into the developer tools for the browsers. For a better experience however it is recommended you install the following add-ons to each browser for a better experience:

=== Google Chrome ===
* https://chrome.google.com/extensions/detail/mfnjijpckfecpgchobgcfndicenjldoe - will display json data in a user-friendly format. Note: This is a great extension and displays json in a very good format, but it appears when viewing XML with the plugin below this plugin seems to insert some data at the top of the page. The xml viewer still works fine and rest assured this information is not IN the XML packet, but rather added in after by your browser and this plugin.
* https://chrome.google.com/extensions/detail/gbammbheopgpmaagmckhpjbfgdfkpadb - will display XML and WDDX in a friendly format directly in your browser page.

=== Firefox ===
* https://addons.mozilla.org/en-US/firefox/addon/10869 - will display json data in a user-friendly format

=== Safari ===
At this time there appears to be no plugins for Safari that can aid in viewing the data formats, it's recommended you use either Chrome or Firefox if you are going to be interacting with the API from the browser.

== Links ==
* http://en.wikipedia.org/wiki/Representational_State_Transfer Wikipedia article on REST
* http://en.wikipedia.org/wiki/SOAP - Wikipedia Article on SOAP protocol

[[Category:api]]

I4A API Guide v1 Deprecated March 31, 2024

2016-11-08T19:14:46Z

Laura: /* API Examples */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations API. The api makes use of the SOAP protocol for authentication only. All other aspects of the API use REST.

Currently the API determines if the user wishes to retrieve an Object or a Collection based on the plurality of the object. So requesting: /membership.contact/ and /membership.contacts/ will access the object and the collection respectively. There is also a /view.XXX/ method that will allow you to retrieve a table or view directly, however that mode is and always will be READONLY.

== Security ==
To access any of the API functionality, you must first authenticate.
Information is available on the [[API Settings]] page on how to obtain the values needed to authenticate and update them if need be.

Authentication can come in one of 2 forms:
=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>http://<site.com>/i4a/api/authenticate/<USER>/<PASSWORD>/<TOKEN></pre>

You will get back a json packet which will contain your authKey which you can then use to make calls to the API.

=== Soap Authentication ===
This method is deprecated and should no longer be used for new projects.
* Use the SOAP method authenticateAdmin that is available from the SOAP WSDL located at:
** <pre>http://<site.com>/i4a/utilities/authenticate.cfc?wsdl</pre>

The authenticateAdmin takes 3 parameters, they are:
* Username: Must be an administrator username capable of logging onto the site admin.
* Password: the password for the user.
* Token: The Token is specific to each website. It will be made available in your site admin.

== Syntax ==
Calling the API involves building a URL that the API engine can decode. The API engine uses the REST method. REST allows you to utilize GET, POST and DELETE methods. Currently the i4a api only supports GET, which means the API is read-only at this time.

To access the API you can test it in your browser. First you should login to your admin, then direct your page to:

<pre>http://site.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>http://site.com/i4a/api/json/membership.contacts/city like Chicago/<authkey></pre>

The REST command is broken up into several parts, they are from left-right

* <code>http://site.com/i4a/api/</code> - this is the base url that every api call will have in common
* /json/ This tells the processor what format to return data in. The options here are Json, XML and WDDX. Json is the fastest format and also more common when using AJAX. For more information see [[api_return_format|API Return Format]]
* /membership.contact/ - This tells the processor what object or table to access.
* /city like Chicago/ - This allows you to filter your results.

=== Filtering ===
Some examples:

* /firstname=don/ - returns records that match firstname=don
* /City Like Chicago/ - returns records where the city field starts with Chicago
* /City CONTAINS CAN/ - finds records where the city field contains the string 'CAN'
* /logincount > 500 / (Need to test this
* /NULL/ - For querying a collection of records, this would allow for NO filter. This is required because simply leaving the filter empty results in 2 // and the 2nd / is removed by apache during the processing.

== API Objects ==

== API Examples ==

* /i4a/api/json/membership.contact/24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/xml/membership.contact/24228/<authkey> - returns an xml packet for contact record ID = 24228
* /i4a/api/wddx/membership.contact/24228/<authkey> - Returns a WDDX packet for contct record ID = 24228
The above examples are only relevent when referencing I4a objects. When interacting with views as below, you must always specify the name/value pair.

* /i4a/api/json/view.ams_contactinformation/id=24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/json/view.ams_contactinformation/lastname like L/<authkey> - Returns a json packet that would contain all matching records where lastname started with the letter L
* /i4a/api/json/view.ams_contactinformation/lastname Like L:isActive=1/<authkey> - Same as above, but further filters by isActive = 1
* /i4a/api/json/membership.contacts/<authkey> - returns all records from the table related to the ORM object com.om.collections.membership.contacts.
* /i4a/api/json/view.ams_contact/<authkey> - returns the same recordset as the example above, but interacts directly with the table itself.

[[Category:api]]

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP Example]]
* [[i4a api Ajax Example|AJax Example]]

== Testing the API ==
Testing the API and inspecting the data returned is very easily achieved with any modern browser. It is worth noting that by default, only Firefox will display XML (if the header is set to text/xml) in a readable format. It is possible however in both Google Chrome and Safari to view the xml data in a user-friendly format by going into the developer tools for the browsers. For a better experience however it is recommended you install the following add-ons to each browser for a better experience:

=== Google Chrome ===
* https://chrome.google.com/extensions/detail/mfnjijpckfecpgchobgcfndicenjldoe - will display json data in a user-friendly format. Note: This is a great extension and displays json in a very good format, but it appears when viewing XML with the plugin below this plugin seems to insert some data at the top of the page. The xml viewer still works fine and rest assured this information is not IN the XML packet, but rather added in after by your browser and this plugin.
* https://chrome.google.com/extensions/detail/gbammbheopgpmaagmckhpjbfgdfkpadb - will display XML and WDDX in a friendly format directly in your browser page.

=== Firefox ===
* https://addons.mozilla.org/en-US/firefox/addon/10869 - will display json data in a user-friendly format

=== Safari ===
At this time there appears to be no plugins for Safari that can aid in viewing the data formats, it's recommended you use either Chrome or Firefox if you are going to be interacting with the API from the browser.

== Links ==
* http://en.wikipedia.org/wiki/Representational_State_Transfer Wikipedia article on REST
* http://en.wikipedia.org/wiki/SOAP - Wikipedia Article on SOAP protocol

[[Category:api]]

I4A API Guide v1 Deprecated March 31, 2024

2016-11-08T19:12:48Z

Laura: /* API Examples */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations API. The api makes use of the SOAP protocol for authentication only. All other aspects of the API use REST.

Currently the API determines if the user wishes to retrieve an Object or a Collection based on the plurality of the object. So requesting: /membership.contact/ and /membership.contacts/ will access the object and the collection respectively. There is also a /view.XXX/ method that will allow you to retrieve a table or view directly, however that mode is and always will be READONLY.

== Security ==
To access any of the API functionality, you must first authenticate.
Information is available on the [[API Settings]] page on how to obtain the values needed to authenticate and update them if need be.

Authentication can come in one of 2 forms:
=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>http://<site.com>/i4a/api/authenticate/<USER>/<PASSWORD>/<TOKEN></pre>

You will get back a json packet which will contain your authKey which you can then use to make calls to the API.

=== Soap Authentication ===
This method is deprecated and should no longer be used for new projects.
* Use the SOAP method authenticateAdmin that is available from the SOAP WSDL located at:
** <pre>http://<site.com>/i4a/utilities/authenticate.cfc?wsdl</pre>

The authenticateAdmin takes 3 parameters, they are:
* Username: Must be an administrator username capable of logging onto the site admin.
* Password: the password for the user.
* Token: The Token is specific to each website. It will be made available in your site admin.

== Syntax ==
Calling the API involves building a URL that the API engine can decode. The API engine uses the REST method. REST allows you to utilize GET, POST and DELETE methods. Currently the i4a api only supports GET, which means the API is read-only at this time.

To access the API you can test it in your browser. First you should login to your admin, then direct your page to:

<pre>http://site.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>http://site.com/i4a/api/json/membership.contacts/city like Chicago/<authkey></pre>

The REST command is broken up into several parts, they are from left-right

* <code>http://site.com/i4a/api/</code> - this is the base url that every api call will have in common
* /json/ This tells the processor what format to return data in. The options here are Json, XML and WDDX. Json is the fastest format and also more common when using AJAX. For more information see [[api_return_format|API Return Format]]
* /membership.contact/ - This tells the processor what object or table to access.
* /city like Chicago/ - This allows you to filter your results.

=== Filtering ===
Some examples:

* /firstname=don/ - returns records that match firstname=don
* /City Like Chicago/ - returns records where the city field starts with Chicago
* /City CONTAINS CAN/ - finds records where the city field contains the string 'CAN'
* /logincount > 500 / (Need to test this
* /NULL/ - For querying a collection of records, this would allow for NO filter. This is required because simply leaving the filter empty results in 2 // and the 2nd / is removed by apache during the processing.

== API Objects ==

== API Examples ==

* /i4a/api/json/membership.contact/24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/xml/membership.contact/24228/<authkey> - returns an xml packet for contact record ID = 24228
* /i4a/api/wddx/membership.contact/24228/<authkey> - Returns a WDDX packet for contct record ID = 24228
The above examples are only relevent when referencing I4a objects. When interacting with views as below, you must always specify the name/value pair.

* /i4a/api/json/view.ams_contactinformation/id=24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/json/membership.contacts/<authkey> - returns all records from the table related to the ORM object com.om.collections.membership.contacts.
* /i4a/api/json/view.ams_contact/<authkey> - returns the same recordset as the example above, but interacts directly with the table itself.

[[Category:api]]

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP Example]]
* [[i4a api Ajax Example|AJax Example]]

== Testing the API ==
Testing the API and inspecting the data returned is very easily achieved with any modern browser. It is worth noting that by default, only Firefox will display XML (if the header is set to text/xml) in a readable format. It is possible however in both Google Chrome and Safari to view the xml data in a user-friendly format by going into the developer tools for the browsers. For a better experience however it is recommended you install the following add-ons to each browser for a better experience:

=== Google Chrome ===
* https://chrome.google.com/extensions/detail/mfnjijpckfecpgchobgcfndicenjldoe - will display json data in a user-friendly format. Note: This is a great extension and displays json in a very good format, but it appears when viewing XML with the plugin below this plugin seems to insert some data at the top of the page. The xml viewer still works fine and rest assured this information is not IN the XML packet, but rather added in after by your browser and this plugin.
* https://chrome.google.com/extensions/detail/gbammbheopgpmaagmckhpjbfgdfkpadb - will display XML and WDDX in a friendly format directly in your browser page.

=== Firefox ===
* https://addons.mozilla.org/en-US/firefox/addon/10869 - will display json data in a user-friendly format

=== Safari ===
At this time there appears to be no plugins for Safari that can aid in viewing the data formats, it's recommended you use either Chrome or Firefox if you are going to be interacting with the API from the browser.

== Links ==
* http://en.wikipedia.org/wiki/Representational_State_Transfer Wikipedia article on REST
* http://en.wikipedia.org/wiki/SOAP - Wikipedia Article on SOAP protocol

[[Category:api]]

Additional Examples

2016-11-08T19:04:06Z

Laura: /* Selecting a Data Source to use with the API */

Additional Examples

2016-11-08T18:58:14Z

Laura: /* Filtering on Member Type and Expiration Date using the API */

==Filtering on Member Type and Expiration Date using the API==

The i4a system can be configured to use the Individual Database Model or the Organizational Database Model. The simplest way to determine the database model is to check for the presence of Manage Organizations on the Membership dropdown menu in the i4a system. If it is present, the system is configured to use the Organizational Database Model, and if it is absent, it is using the Individual Database Model.

===Selecting a Data Source to use with the API===

Here are two views that can be used with the API, and contain membership information. This is not a complete list of all available views. Contact i4a for support if you are not able to get what you need using the views or tables in the examples provided.

* '''ams_contactinformation_membertype''' - Includes the "membertype" field which contains the record's Member Type if it is populated. The "paidthru" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the individual database model only.'''''

* '''ams_contactinformation_corptype''' - Includes the "corptype" field which contains the record's Member Type if it is populated. The "corpexpiration" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the organizational database model only.'''''

Below are some examples specific to each database model:

===Individual Database Model Examples===

The examples below uses the view ams_contactinformation_membertype. This view should only be used with the i4a Individual Database Model:

* /i4a/api/json/view.ams_contactinformation_membertype/membertype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular. Current and expired members would be returned in this example.

* /i4a/api/json/view.ams_contactinformation_membertype/membertype is not null/<authkey> - Returns a json packet that contains all matching records that have a member type. Current and expired members would be returned in this example.

===Organizational Database Model Examples===

The following example uses the view ams_contactinformation_corptype. This view should only be used with the i4a Organizational Database Model.

* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.

Additional Examples

2016-11-08T18:57:40Z

Laura:

==Filtering on Member Type and Expiration Date using the API==

The i4a system can be configured to use the Individual Database Model or the Organizational Database Model. The simplest way to determine the database model is to check for the presence of Manage Organizations on the Membership dropdown menu in the i4a system. If it is present, the system is configured to use the Organizational Database Model, and if it is absent, it is using the Individual Database Model.

===Selecting a Data Source to use with the API===

Here are two views that can be used with the API, and contain membership information. This is not a complete list of all available views. Contact i4a for support if you are not able to get what you need using the views or tables in the examples provided.

* '''ams_contactinformation_membertype''' - Includes the "membertype" field which contains the record's Member Type if it is populated. The "paidthru" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the individual database model only.'''''

* '''ams_contactinformation_corptype''' - Includes the "corptype" field which contains the record's Member Type if it is populated. The "corpexpiration" field contains the record's Expiration Date. Records with a member type and a future expiration date are current members. '''''Use this with the organizational database model only.'''''

Below are some examples specific to each database model:

===Individual Database Model Examples===

The examples below uses the view ams_contactinformation_membertype. This view should only be used with the i4a Individual Database Model:

* /i4a/api/json/view.ams_contactinformation_membertype/membertype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular. Current and expired members would be returned in this example.

* /i4a/api/json/view.ams_contactinformation_membertype/membertype is not null/<authkey> - Returns a json packet that contains all matching records that have a member type. Current and expired members would be returned in this example.

===Organizational Database Model Examples===

The following example uses the view ams_contactinformation_corptype. This view should only be used with the i4a Organizational Database Model.

* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular.

Additional Examples

2016-11-08T18:36:04Z

Laura: /* Organizational Database Model Examples */

Additional Examples

2016-11-08T18:14:33Z

Laura: /* Organizational Database Model Examples */

Additional Examples

2016-11-08T18:13:51Z

Laura: /* Individual Database Model Examples */

Additional Examples

2016-11-08T18:11:14Z

Laura: /* Individual Database Model Examples */

==Filtering on Member Type and Expiration Date using the API==

The i4a system can be configured to use the Individual Database Model or the Organizational Database Model. The simplest way to determine the database model is to check for the presence of Manage Organizations on the Membership dropdown menu in the i4a system. If it is present, the system is configured to use the Organizational Database Model, and if it is absent, it is using the Individual Database Model.

Below are some examples specific to each database model:

===Individual Database Model Examples===

The examples below uses the view ams_contactinformation_membertype. This view should only be used with the i4a Individual Database Model:

* /i4a/api/json/view.ams_contactinformation_membertype/membertype=Regular:isActive=1/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all active database records where the member type is Regular. Current and expired members would be returned in this example.

* /i4a/api/json/view.ams_contactinformation_membertype/membertype is not null/<authkey> - Returns a json packet that contains all matching records that have a member type. Current and expired members would be returned in this example.

* /i4a/api/json/view.ams_contactinformation_membertype/membertype is not null/<authkey> - Returns a json packet that contains all matching records that have a member type. Current and expired members would be returned in this example.

===Organizational Database Model Examples===

* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all matching records where the member type is Regular.

Additional Examples

2016-11-08T18:09:59Z

Laura: Created page with "==Filtering on Member Type and Expiration Date using the API== The i4a system can be configured to use the Individual Database Model or the Organizational Database Model. The..."

==Filtering on Member Type and Expiration Date using the API==

The i4a system can be configured to use the Individual Database Model or the Organizational Database Model. The simplest way to determine the database model is to check for the presence of Manage Organizations on the Membership dropdown menu in the i4a system. If it is present, the system is configured to use the Organizational Database Model, and if it is absent, it is using the Individual Database Model.

Below are some examples specific to each database model:

===Individual Database Model Examples===

The examples below uses the view ams_contactinformation_membertype. This view should only be used with the i4a Individual Database Model:

* /i4a/api/json/view.ams_contactinformation_membertype/membertype=Regular/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all matching records where the member type is Regular. Current and expired members would be returned in this example.

* /i4a/api/json/view.ams_contactinformation_membertype/membertype is not null/<authkey> - Returns a json packet that contains all matching records that have a member type. Current and expired members would be returned in this example.

* /i4a/api/json/view.ams_contactinformation_membertype/membertype is not null/<authkey> - Returns a json packet that contains all matching records that have a member type. Current and expired members would be returned in this example.

===Organizational Database Model Examples===

* /i4a/api/json/view.ams_contactinformation_corptype/corptype=Regular/<authkey> - This example's only purpose is to show how you could filter for a specific member type using this view. In this specific view, the member type field is called corptype. The search string "Regular" should be replaced by the name of a member type that exists in the database you are querying. Returns a json packet that contains all matching records where the member type is Regular.

I4A API Guide v1 Deprecated March 31, 2024

2016-11-08T17:52:56Z

Laura: /* API Examples */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations API. The api makes use of the SOAP protocol for authentication only. All other aspects of the API use REST.

Currently the API determines if the user wishes to retrieve an Object or a Collection based on the plurality of the object. So requesting: /membership.contact/ and /membership.contacts/ will access the object and the collection respectively. There is also a /view.XXX/ method that will allow you to retrieve a table or view directly, however that mode is and always will be READONLY.

== Security ==
To access any of the API functionality, you must first authenticate.
Information is available on the [[API Settings]] page on how to obtain the values needed to authenticate and update them if need be.

Authentication can come in one of 2 forms:
=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>http://<site.com>/i4a/api/authenticate/<USER>/<PASSWORD>/<TOKEN></pre>

You will get back a json packet which will contain your authKey which you can then use to make calls to the API.

=== Soap Authentication ===
This method is deprecated and should no longer be used for new projects.
* Use the SOAP method authenticateAdmin that is available from the SOAP WSDL located at:
** <pre>http://<site.com>/i4a/utilities/authenticate.cfc?wsdl</pre>

The authenticateAdmin takes 3 parameters, they are:
* Username: Must be an administrator username capable of logging onto the site admin.
* Password: the password for the user.
* Token: The Token is specific to each website. It will be made available in your site admin.

== Syntax ==
Calling the API involves building a URL that the API engine can decode. The API engine uses the REST method. REST allows you to utilize GET, POST and DELETE methods. Currently the i4a api only supports GET, which means the API is read-only at this time.

To access the API you can test it in your browser. First you should login to your admin, then direct your page to:

<pre>http://site.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>http://site.com/i4a/api/json/membership.contacts/city like Chicago/<authkey></pre>

The REST command is broken up into several parts, they are from left-right

* <code>http://site.com/i4a/api/</code> - this is the base url that every api call will have in common
* /json/ This tells the processor what format to return data in. The options here are Json, XML and WDDX. Json is the fastest format and also more common when using AJAX. For more information see [[api_return_format|API Return Format]]
* /membership.contact/ - This tells the processor what object or table to access.
* /city like Chicago/ - This allows you to filter your results.

=== Filtering ===
Some examples:

* /firstname=don/ - returns records that match firstname=don
* /City Like Chicago/ - returns records where the city field starts with Chicago
* /City CONTAINS CAN/ - finds records where the city field contains the string 'CAN'
* /logincount > 500 / (Need to test this
* /NULL/ - For querying a collection of records, this would allow for NO filter. This is required because simply leaving the filter empty results in 2 // and the 2nd / is removed by apache during the processing.

== API Objects ==

== API Examples ==

* /i4a/api/json/membership.contact/24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/xml/membership.contact/24228/<authkey> - returns an xml packet for contact record ID = 24228
* /i4a/api/wddx/membership.contact/24228/<authkey> - Returns a WDDX packet for contct record ID = 24228
The above examples are only relevent when referencing I4a objects. When interacting with views as below, you must always specify the name/value pair.

* /i4a/api/json/view.ams_contactinformation/id=24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/json/view.All Contacts/lastname like L/<authkey> - Returns a json packet that would contain all matching records where lastname started with the letter L
* /i4a/api/json/view.All Contacts/lastname Like L:isActive=1/<authkey> - Same as above, but further filters by isActive = 1
* /i4a/api/json/membership.contacts/<authkey> - returns all records from the table related to the ORM object com.om.collections.membership.contacts.
* /i4a/api/json/view.ams_contact/<authkey> - returns the same recordset as the example above, but interacts directly with the table itself.

[[Category:api]]

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP Example]]
* [[i4a api Ajax Example|AJax Example]]

== Testing the API ==
Testing the API and inspecting the data returned is very easily achieved with any modern browser. It is worth noting that by default, only Firefox will display XML (if the header is set to text/xml) in a readable format. It is possible however in both Google Chrome and Safari to view the xml data in a user-friendly format by going into the developer tools for the browsers. For a better experience however it is recommended you install the following add-ons to each browser for a better experience:

=== Google Chrome ===
* https://chrome.google.com/extensions/detail/mfnjijpckfecpgchobgcfndicenjldoe - will display json data in a user-friendly format. Note: This is a great extension and displays json in a very good format, but it appears when viewing XML with the plugin below this plugin seems to insert some data at the top of the page. The xml viewer still works fine and rest assured this information is not IN the XML packet, but rather added in after by your browser and this plugin.
* https://chrome.google.com/extensions/detail/gbammbheopgpmaagmckhpjbfgdfkpadb - will display XML and WDDX in a friendly format directly in your browser page.

=== Firefox ===
* https://addons.mozilla.org/en-US/firefox/addon/10869 - will display json data in a user-friendly format

=== Safari ===
At this time there appears to be no plugins for Safari that can aid in viewing the data formats, it's recommended you use either Chrome or Firefox if you are going to be interacting with the API from the browser.

== Links ==
* http://en.wikipedia.org/wiki/Representational_State_Transfer Wikipedia article on REST
* http://en.wikipedia.org/wiki/SOAP - Wikipedia Article on SOAP protocol

[[Category:api]]

I4A API Guide v1 Deprecated March 31, 2024

2016-11-08T17:52:24Z

Laura: /* API Examples */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations API. The api makes use of the SOAP protocol for authentication only. All other aspects of the API use REST.

Currently the API determines if the user wishes to retrieve an Object or a Collection based on the plurality of the object. So requesting: /membership.contact/ and /membership.contacts/ will access the object and the collection respectively. There is also a /view.XXX/ method that will allow you to retrieve a table or view directly, however that mode is and always will be READONLY.

== Security ==
To access any of the API functionality, you must first authenticate.
Information is available on the [[API Settings]] page on how to obtain the values needed to authenticate and update them if need be.

Authentication can come in one of 2 forms:
=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>http://<site.com>/i4a/api/authenticate/<USER>/<PASSWORD>/<TOKEN></pre>

You will get back a json packet which will contain your authKey which you can then use to make calls to the API.

=== Soap Authentication ===
This method is deprecated and should no longer be used for new projects.
* Use the SOAP method authenticateAdmin that is available from the SOAP WSDL located at:
** <pre>http://<site.com>/i4a/utilities/authenticate.cfc?wsdl</pre>

The authenticateAdmin takes 3 parameters, they are:
* Username: Must be an administrator username capable of logging onto the site admin.
* Password: the password for the user.
* Token: The Token is specific to each website. It will be made available in your site admin.

== Syntax ==
Calling the API involves building a URL that the API engine can decode. The API engine uses the REST method. REST allows you to utilize GET, POST and DELETE methods. Currently the i4a api only supports GET, which means the API is read-only at this time.

To access the API you can test it in your browser. First you should login to your admin, then direct your page to:

<pre>http://site.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>http://site.com/i4a/api/json/membership.contacts/city like Chicago/<authkey></pre>

The REST command is broken up into several parts, they are from left-right

* <code>http://site.com/i4a/api/</code> - this is the base url that every api call will have in common
* /json/ This tells the processor what format to return data in. The options here are Json, XML and WDDX. Json is the fastest format and also more common when using AJAX. For more information see [[api_return_format|API Return Format]]
* /membership.contact/ - This tells the processor what object or table to access.
* /city like Chicago/ - This allows you to filter your results.

=== Filtering ===
Some examples:

* /firstname=don/ - returns records that match firstname=don
* /City Like Chicago/ - returns records where the city field starts with Chicago
* /City CONTAINS CAN/ - finds records where the city field contains the string 'CAN'
* /logincount > 500 / (Need to test this
* /NULL/ - For querying a collection of records, this would allow for NO filter. This is required because simply leaving the filter empty results in 2 // and the 2nd / is removed by apache during the processing.

== API Objects ==

== API Examples ==

* /i4a/api/json/membership.contact/24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/xml/membership.contact/24228/<authkey> - returns an xml packet for contact record ID = 24228
* /i4a/api/wddx/membership.contact/24228/<authkey> - Returns a WDDX packet for contct record ID = 24228
The above examples are only relevent when referencing I4a objects. When interacting with views as below, you must always specify the name/value pair.

* /i4a/api/json/view.ams_contactinformation/id=24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/json/view.All Contacts/lastname like L//<authkey> - Returns a json packet that would contain all matching records where lastname started with the letter L
* /i4a/api/json/view.All Contacts/lastname Like L:isActive=1//<authkey> - Same as above, but further filters by isActive = 1
* /i4a/api/json/membership.contacts/<authkey> - returns all records from the table related to the ORM object com.om.collections.membership.contacts.
* /i4a/api/json/view.ams_contact/<authkey> - returns the same recordset as the example above, but interacts directly with the table itself.

[[Category:api]]

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP Example]]
* [[i4a api Ajax Example|AJax Example]]

== Testing the API ==
Testing the API and inspecting the data returned is very easily achieved with any modern browser. It is worth noting that by default, only Firefox will display XML (if the header is set to text/xml) in a readable format. It is possible however in both Google Chrome and Safari to view the xml data in a user-friendly format by going into the developer tools for the browsers. For a better experience however it is recommended you install the following add-ons to each browser for a better experience:

=== Google Chrome ===
* https://chrome.google.com/extensions/detail/mfnjijpckfecpgchobgcfndicenjldoe - will display json data in a user-friendly format. Note: This is a great extension and displays json in a very good format, but it appears when viewing XML with the plugin below this plugin seems to insert some data at the top of the page. The xml viewer still works fine and rest assured this information is not IN the XML packet, but rather added in after by your browser and this plugin.
* https://chrome.google.com/extensions/detail/gbammbheopgpmaagmckhpjbfgdfkpadb - will display XML and WDDX in a friendly format directly in your browser page.

=== Firefox ===
* https://addons.mozilla.org/en-US/firefox/addon/10869 - will display json data in a user-friendly format

=== Safari ===
At this time there appears to be no plugins for Safari that can aid in viewing the data formats, it's recommended you use either Chrome or Firefox if you are going to be interacting with the API from the browser.

== Links ==
* http://en.wikipedia.org/wiki/Representational_State_Transfer Wikipedia article on REST
* http://en.wikipedia.org/wiki/SOAP - Wikipedia Article on SOAP protocol

[[Category:api]]

I4A API Guide v1 Deprecated March 31, 2024

2016-11-04T17:12:11Z

Laura: /* API Examples */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations API. The api makes use of the SOAP protocol for authentication only. All other aspects of the API use REST.

Currently the API determines if the user wishes to retrieve an Object or a Collection based on the plurality of the object. So requesting: /membership.contact/ and /membership.contacts/ will access the object and the collection respectively. There is also a /view.XXX/ method that will allow you to retrieve a table or view directly, however that mode is and always will be READONLY.

== Security ==
To access any of the API functionality, you must first authenticate.
Information is available on the [[API Settings]] page on how to obtain the values needed to authenticate and update them if need be.

Authentication can come in one of 2 forms:
=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>http://<site.com>/i4a/api/authenticate/<USER>/<PASSWORD>/<TOKEN></pre>

You will get back a json packet which will contain your authKey which you can then use to make calls to the API.

=== Soap Authentication ===
This method is deprecated and should no longer be used for new projects.
* Use the SOAP method authenticateAdmin that is available from the SOAP WSDL located at:
** <pre>http://<site.com>/i4a/utilities/authenticate.cfc?wsdl</pre>

The authenticateAdmin takes 3 parameters, they are:
* Username: Must be an administrator username capable of logging onto the site admin.
* Password: the password for the user.
* Token: The Token is specific to each website. It will be made available in your site admin.

== Syntax ==
Calling the API involves building a URL that the API engine can decode. The API engine uses the REST method. REST allows you to utilize GET, POST and DELETE methods. Currently the i4a api only supports GET, which means the API is read-only at this time.

To access the API you can test it in your browser. First you should login to your admin, then direct your page to:

<pre>http://site.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>http://site.com/i4a/api/json/membership.contacts/city like Chicago/<authkey></pre>

The REST command is broken up into several parts, they are from left-right

* <code>http://site.com/i4a/api/</code> - this is the base url that every api call will have in common
* /json/ This tells the processor what format to return data in. The options here are Json, XML and WDDX. Json is the fastest format and also more common when using AJAX. For more information see [[api_return_format|API Return Format]]
* /membership.contact/ - This tells the processor what object or table to access.
* /city like Chicago/ - This allows you to filter your results.

=== Filtering ===
Some examples:

* /firstname=don/ - returns records that match firstname=don
* /City Like Chicago/ - returns records where the city field starts with Chicago
* /City CONTAINS CAN/ - finds records where the city field contains the string 'CAN'
* /logincount > 500 / (Need to test this
* /NULL/ - For querying a collection of records, this would allow for NO filter. This is required because simply leaving the filter empty results in 2 // and the 2nd / is removed by apache during the processing.

== API Objects ==

== API Examples ==

* /i4a/api/json/membership.contact/24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/xml/membership.contact/24228/<authkey> - returns an xml packet for contact record ID = 24228
* /i4a/api/wddx/membership.contact/24228/<authkey> - Returns a WDDX packet for contct record ID = 24228
The above examples are only relevent when referencing I4a objects. When interacting with views as below, you must always specify the name/value pair.

* /i4a/api/json/view.ams_contactinformation/id=24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/json/view.ams_contactinformation_membertype/membertype like Regular//<authkey> - Returns a json packet that contains all matching records where the user's member type starts with the word Regular. The view in this example should only be used by customers with the i4a individual database model.
* /i4a/api/json/view.ams_contactinformation_corptype/corptype like Regular//<authkey> - Returns a json packet that contains all matching records where the user's member type starts with the word Regular. The view in this example should only be used by customers with the i4a organizational database model.
* /i4a/api/json/view.All Contacts/lastname like L//<authkey> - Returns a json packet that would contain all matching records where lastname started with the letter L
* /i4a/api/json/view.All Contacts/lastname Like L:isActive=1//<authkey> - Same as above, but further filters by isActive = 1
* /i4a/api/json/membership.contacts/<authkey> - returns all records from the table related to the ORM object com.om.collections.membership.contacts.
* /i4a/api/json/view.ams_contact/<authkey> - returns the same recordset as the example above, but interacts directly with the table itself.

[[Category:api]]

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP Example]]
* [[i4a api Ajax Example|AJax Example]]

== Testing the API ==
Testing the API and inspecting the data returned is very easily achieved with any modern browser. It is worth noting that by default, only Firefox will display XML (if the header is set to text/xml) in a readable format. It is possible however in both Google Chrome and Safari to view the xml data in a user-friendly format by going into the developer tools for the browsers. For a better experience however it is recommended you install the following add-ons to each browser for a better experience:

=== Google Chrome ===
* https://chrome.google.com/extensions/detail/mfnjijpckfecpgchobgcfndicenjldoe - will display json data in a user-friendly format. Note: This is a great extension and displays json in a very good format, but it appears when viewing XML with the plugin below this plugin seems to insert some data at the top of the page. The xml viewer still works fine and rest assured this information is not IN the XML packet, but rather added in after by your browser and this plugin.
* https://chrome.google.com/extensions/detail/gbammbheopgpmaagmckhpjbfgdfkpadb - will display XML and WDDX in a friendly format directly in your browser page.

=== Firefox ===
* https://addons.mozilla.org/en-US/firefox/addon/10869 - will display json data in a user-friendly format

=== Safari ===
At this time there appears to be no plugins for Safari that can aid in viewing the data formats, it's recommended you use either Chrome or Firefox if you are going to be interacting with the API from the browser.

== Links ==
* http://en.wikipedia.org/wiki/Representational_State_Transfer Wikipedia article on REST
* http://en.wikipedia.org/wiki/SOAP - Wikipedia Article on SOAP protocol

[[Category:api]]

I4A API Guide v1 Deprecated March 31, 2024

2016-11-04T17:06:51Z

Laura: /* API Examples */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations API. The api makes use of the SOAP protocol for authentication only. All other aspects of the API use REST.

Currently the API determines if the user wishes to retrieve an Object or a Collection based on the plurality of the object. So requesting: /membership.contact/ and /membership.contacts/ will access the object and the collection respectively. There is also a /view.XXX/ method that will allow you to retrieve a table or view directly, however that mode is and always will be READONLY.

== Security ==
To access any of the API functionality, you must first authenticate.
Information is available on the [[API Settings]] page on how to obtain the values needed to authenticate and update them if need be.

Authentication can come in one of 2 forms:
=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>http://<site.com>/i4a/api/authenticate/<USER>/<PASSWORD>/<TOKEN></pre>

You will get back a json packet which will contain your authKey which you can then use to make calls to the API.

=== Soap Authentication ===
This method is deprecated and should no longer be used for new projects.
* Use the SOAP method authenticateAdmin that is available from the SOAP WSDL located at:
** <pre>http://<site.com>/i4a/utilities/authenticate.cfc?wsdl</pre>

The authenticateAdmin takes 3 parameters, they are:
* Username: Must be an administrator username capable of logging onto the site admin.
* Password: the password for the user.
* Token: The Token is specific to each website. It will be made available in your site admin.

== Syntax ==
Calling the API involves building a URL that the API engine can decode. The API engine uses the REST method. REST allows you to utilize GET, POST and DELETE methods. Currently the i4a api only supports GET, which means the API is read-only at this time.

To access the API you can test it in your browser. First you should login to your admin, then direct your page to:

<pre>http://site.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>http://site.com/i4a/api/json/membership.contacts/city like Chicago/<authkey></pre>

The REST command is broken up into several parts, they are from left-right

* <code>http://site.com/i4a/api/</code> - this is the base url that every api call will have in common
* /json/ This tells the processor what format to return data in. The options here are Json, XML and WDDX. Json is the fastest format and also more common when using AJAX. For more information see [[api_return_format|API Return Format]]
* /membership.contact/ - This tells the processor what object or table to access.
* /city like Chicago/ - This allows you to filter your results.

=== Filtering ===
Some examples:

* /firstname=don/ - returns records that match firstname=don
* /City Like Chicago/ - returns records where the city field starts with Chicago
* /City CONTAINS CAN/ - finds records where the city field contains the string 'CAN'
* /logincount > 500 / (Need to test this
* /NULL/ - For querying a collection of records, this would allow for NO filter. This is required because simply leaving the filter empty results in 2 // and the 2nd / is removed by apache during the processing.

== API Objects ==

== API Examples ==

* /i4a/api/json/membership.contact/24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/xml/membership.contact/24228/<authkey> - returns an xml packet for contact record ID = 24228
* /i4a/api/wddx/membership.contact/24228/<authkey> - Returns a WDDX packet for contct record ID = 24228
The above examples are only relevent when referencing I4a objects. When interacting with views as below, you must always specify the name/value pair.

* /i4a/api/json/view.ams_contactinformation/id=24228/<authkey> - Returns a json packet for contact record ID = 24228
* /i4a/api/json/view.ams_contactinformation_membertype/membertype like Regular//<authkey> - Returns a json packet that contains all matching records where membertype starts with the word Regular
* /i4a/api/json/view.All Contacts/lastname like L//<authkey> - Returns a json packet that would contain all matching records where lastname started with the letter L
* /i4a/api/json/view.All Contacts/lastname Like L:isActive=1//<authkey> - Same as above, but further filters by isActive = 1
* /i4a/api/json/membership.contacts/<authkey> - returns all records from the table related to the ORM object com.om.collections.membership.contacts.
* /i4a/api/json/view.ams_contact/<authkey> - returns the same recordset as the example above, but interacts directly with the table itself.

[[Category:api]]

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP Example]]
* [[i4a api Ajax Example|AJax Example]]

== Testing the API ==
Testing the API and inspecting the data returned is very easily achieved with any modern browser. It is worth noting that by default, only Firefox will display XML (if the header is set to text/xml) in a readable format. It is possible however in both Google Chrome and Safari to view the xml data in a user-friendly format by going into the developer tools for the browsers. For a better experience however it is recommended you install the following add-ons to each browser for a better experience:

=== Google Chrome ===
* https://chrome.google.com/extensions/detail/mfnjijpckfecpgchobgcfndicenjldoe - will display json data in a user-friendly format. Note: This is a great extension and displays json in a very good format, but it appears when viewing XML with the plugin below this plugin seems to insert some data at the top of the page. The xml viewer still works fine and rest assured this information is not IN the XML packet, but rather added in after by your browser and this plugin.
* https://chrome.google.com/extensions/detail/gbammbheopgpmaagmckhpjbfgdfkpadb - will display XML and WDDX in a friendly format directly in your browser page.

=== Firefox ===
* https://addons.mozilla.org/en-US/firefox/addon/10869 - will display json data in a user-friendly format

=== Safari ===
At this time there appears to be no plugins for Safari that can aid in viewing the data formats, it's recommended you use either Chrome or Firefox if you are going to be interacting with the API from the browser.

== Links ==
* http://en.wikipedia.org/wiki/Representational_State_Transfer Wikipedia article on REST
* http://en.wikipedia.org/wiki/SOAP - Wikipedia Article on SOAP protocol

[[Category:api]]