i4a API Wiki - User contributions [en]

I4A API Guide

2025-10-03T12:13:20Z

Andrea: Andrea moved page I4A API Guide to I4A API Guide v1 Deprecated March 31, 2024

#REDIRECT [[I4A API Guide v1 Deprecated March 31, 2024]]

I4A API Guide v1 Deprecated March 31, 2024

2025-10-03T12:13:20Z

Andrea: Andrea moved page I4A API Guide to I4A API Guide v1 Deprecated March 31, 2024

= I4A v 1.0 API Guide =

<blockquote style="border: solid red; width: 75%; padding: 10px">
<big>'''API v 1.0 DEPRECATED AS OF March 31, 2024.'''</big>

Version 2.0 of our API offers more security and is easier to implement and use. It offers numerous endpoints for retrieving data - such as Contacts, Membership, and custom views.

<big>[https://api.i4a.com/index.php/I4A_API_2.0 i4a API 2.0 documentation]</big>

</blockquote>

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<yourwebsite.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.


== 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>https://<yourwebsite.com>/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://<yourwebsite.com>/i4a/api/json/membership.contacts/firstName like Rob/<authkey></pre>

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

* <nowiki>https://<yourwebsite.com>/i4a/api/</nowiki> - 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=john/ - returns records that match firstname=john
* /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 relevant 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]]'''

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP 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

2025-10-03T12:03:12Z

Andrea: /* I4A API Guide */

I4A API Guide v1 Deprecated March 31, 2024

2025-10-03T12:02:45Z

Andrea: /* I4A API Guide */

= I4A API Guide =

<blockquote style="border: solid red; width: 75%; padding: 10px">
<big>'''API v 1.0 DEPRECATED AS OF March 31, 2024.'''</big>

Version 2.0 of our API offers more security and is easier to implement and use. It offers numerous endpoints for retrieving data - such as Contacts, Membership, and custom views.

<big>[https://api.i4a.com/index.php/I4A_API_2.0 i4a API 2.0 documentation]</big>

</blockquote>

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<yourwebsite.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.


== 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>https://<yourwebsite.com>/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://<yourwebsite.com>/i4a/api/json/membership.contacts/firstName like Rob/<authkey></pre>

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

* <nowiki>https://<yourwebsite.com>/i4a/api/</nowiki> - 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=john/ - returns records that match firstname=john
* /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 relevant 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]]'''

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP 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]]

Main Page

2024-05-17T14:50:43Z

Andrea:

'''Welcome to the i4a API Wiki.'''

i4a provides a secure API that allows you to access your data remotely and programmatically.

== API Documentation ==
* [https://api.i4a.com/index.php/I4A_API_2.0 i4a API 2.0 documentation]

I4A API Guide v1 Deprecated March 31, 2024

2023-11-03T12:58:06Z

Andrea: /* I4A API Guide */

= I4A API Guide =

<blockquote style="border: solid red; width: 75%; padding: 10px">
<big>'''Update your API integrations to v 2.0 before March 31, 2024.'''</big>

Version 2.0 of our API offers more security and is easier to implement and use. It offers numerous endpoints for retrieving data - such as Contacts, Membership, and custom views.

API v 1.0 will continue to work until '''March 31, 2024'''. We encourage you or your third-party vendors to update your integrations now.

[https://api.i4a.com/index.php/I4A_API_2.0 i4a API 2.0 documentation]

</blockquote>

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<yourwebsite.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.


== 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>https://<yourwebsite.com>/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://<yourwebsite.com>/i4a/api/json/membership.contacts/firstName like Rob/<authkey></pre>

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

* <nowiki>https://<yourwebsite.com>/i4a/api/</nowiki> - 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=john/ - returns records that match firstname=john
* /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 relevant 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]]'''

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP 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

2023-11-03T12:56:58Z

Andrea:

= I4A API Guide =

<blockquote style="border: solid red; width: 75%; padding: 10px">
<big>'''Update your API integrations to v 2.0 before March 31, 2024.'''</big>

Version 2.0 of our API offers more security and is easier to implement and use. It offers numerous endpoints for retrieving data - such as Contacts, Membership, and custom views.

API v 1.0 will continue to work until '''March 31, 2024'''. We encourage you or your third-party vendors to update your integrations now.

[https://api.i4a.com/index.php/I4A_API_2.0 i4a API 2.0 documentation]

</blockquote>

=== API 1.0 is being deprecated in 2024. Please update your integrations as soon as possible to [[I4A API 2.0]] ===

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<yourwebsite.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.


== 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>https://<yourwebsite.com>/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://<yourwebsite.com>/i4a/api/json/membership.contacts/firstName like Rob/<authkey></pre>

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

* <nowiki>https://<yourwebsite.com>/i4a/api/</nowiki> - 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=john/ - returns records that match firstname=john
* /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 relevant 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]]'''

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP 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]]

Main Page

2023-11-03T12:55:44Z

Andrea:

'''Welcome to the i4a API Wiki.'''

i4a provides a secure API that allows you to access your data remotely and programmatically.

<blockquote style="border: solid red; width: 75%; padding: 10px">
<big>'''Update your API integrations to v 2.0 before March 31, 2024.'''</big>

Version 2.0 of our API offers more security and is easier to implement and use. It offers numerous endpoints for retrieving data - such as Contacts, Membership, and custom views.

API v 1.0 will continue to work until '''March 31, 2024'''. We encourage you or your third-party vendors to update your integrations now.
</blockquote>

== API Documentation Links ==
* [https://api.i4a.com/index.php/I4A_API_2.0 i4a API 2.0 documentation]

* [https://api.i4a.com/index.php/I4A_API_Guide i4a API 1.0 documentation]

Main Page

2023-11-03T12:54:34Z

Andrea: /* API Documentation Links */

'''Welcome to the i4a API Wiki.'''

i4a provides a secure API that allows you to access your data remotely and programmatically.

<big>'''Update your API integrations to v 2.0 before March 31, 2024.'''</big>

Version 2.0 of our API offers more security and is easier to implement and use. It offers numerous endpoints for retrieving data - such as Contacts, Membership, and custom views.

API v 1.0 will continue to work until '''March 31, 2024'''. We encourage you or your third-party vendors to update your integrations now.

== API Documentation Links ==
* [https://api.i4a.com/index.php/I4A_API_2.0 i4a API 2.0 documentation]

* [https://api.i4a.com/index.php/I4A_API_Guide i4a API 1.0 documentation]

I4a api PHP Example

2022-09-21T21:01:32Z

Andrea: Andrea moved page I4a api PHP Example to I4a API PHP Example

#REDIRECT [[I4a API PHP Example]]

I4a API PHP Example

2022-09-21T21:01:32Z

Andrea: Andrea moved page I4a api PHP Example to I4a API PHP Example

[[I4A API Guide]]

The following code will connect and retrieve all the contacts who have a lastname that starts with a b.

<source lang="php">
<?php

/*
* For the return format section of the URL, the following options are available:
* json - returns a json packet WITH header. The header includes the content type set to application/json
* json_noheader - returns a json packet with NO header. PHP seems to cannot decode a json packet if it includes
* a header, the header may be needed depending on how this API is used.
* xml - returns an XML packet WITH header. This will return the content type set to text/xml
* xml_noheader - returns an xml packet with NO header. This may be needed depending on your usage.
* wddx - an XML packet formatted in the WDDX specification. It includes a header set to text/xml.
* wddx_noheader - xml packet formatted to WDDX spec, does not include header.
*
*/

$username = 'adminuser1';
$password = 'thepassword';
$site_token = 'xxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx';
$wsdl_url = 'http://www.mysite.org/i4a/utilities/authenticateAdmin.cfc?wsdl';
$search_url = 'http://www.mysite.org/i4a/api/json_noheader/membership.contacts/lastname%20like%20b/';

// We need to authenticate, but once we have our authKey we won't need to repeat that
// The cache_wsdl option may not be needed, but it was in testing for us and possibly other options may be required for this to work.
// For more information see the documentation at http://www.php.net
$client = new SoapClient($wsdl_url,array('cache_wsdl'=>WSDL_CACHE_NONE) );
$adminXML = $client->authenticateAdmin($username,$password,$site_token);
$adminJSON = json_decode(json_encode((array) simplexml_load_string($adminXML)),1);
dump($adminJSON,"response packet from authentication");
$authKey = ($adminJSON['@attributes']['authKey']);
echo '<hr>authKey='.$authKey.'/ ';

// now we've authenticated and have our key, let's access the API...
echo 'API URL='.$search_url . " ";
echo "url string=".$search_url.$authKey . " ";
// retrieve the http output into a variable. Could use cURL functions as well most likely.
$contactJSON = file_get_contents($search_url.$authKey);
echo "<hr>Json Packet: ";
echo $contactJSON;

function dump($vars,$label='') {
echo "<table border=1>";
echo "<tr><td colspan=2>$label</td></tr>";
echo "<tr><td bgcolor='#088A85'>Variable</td><td bgcolor='#088A85'>Value</td></tr>";
if (gettype($vars) == "array" || gettype($vars) == "object") {
foreach ($vars as $key => $value) {
echo "<tr><td bgcolor='#DDDDDD'>$key (".gettype($value).")</td><td>";
if (gettype($value) == "array" || gettype($value) == "object") {dump($vars=$value,$label=$key); } else { echo $value; }
echo "</td></tr>";
}
}
else { echo "<tr><td>".gettype($vars) . "</td><td>"; echo $vars."</td></tr>"; }
echo "</table> ";
}

?>
</source>

[[Category:API]]

Api return format

2022-09-21T20:19:29Z

Andrea: Andrea moved page Api return format to API Return Format

#REDIRECT [[API Return Format]]

API Return Format

2022-09-21T20:19:29Z

Andrea: Andrea moved page Api return format to API Return Format

[[I4A API Guide]]

== Description ==
The API uses the REST methodology and can return data back to the sender in a number of formats. They are:

== Usage ==
Simply put the return format in the URL string right after the /i4a/api/ part of the URL. By default each format will set the content-type in the HTML header. This is known to cause problems with some browsers and frameworks. If you are experiencing issues you can append _noheader to the format name and the data will be returned to you "RAW" with no headers being set. For instance you can could pass:

/i4a/api/json_noheader/membership.contact/24228 and it would return the same json data, but would not populate the HEADER that is returned to the calling page.

=== json ===
Json is a compact text based format, that at first glance looks somewhat like a traditional CSV file. It is becoming very popular with Web 2.0 and is used most often with AJAX.

=== xml ===

=== wddx ===
Wddx is nothing more than a specialized XML packet. It has a defined structure in how the XML is organized, but otherwise it is identical to an XML document.

=== Links ===
* https://www.json.org/ - The source for information on json format
* https://en.wikipedia.org/wiki/JSON - Wikipedia article on json format
* https://en.wikipedia.org/wiki/XML - Wikipedia article on xml format
* https://en.wikipedia.org/wiki/Wddx - Wikipedia article on wddx format

[[Category:API]]

API Return Format

2022-09-21T20:19:15Z

Andrea:

API Return Format

2022-09-21T20:18:46Z

Andrea:

[[I4A API Guide]]

== Description ==
The API uses the REST methodology and can return data back to the sender in a number of formats. They are:

== Usage ==
Simply put the return format in the url string right after the /i4a/api/ part of the url. By default each format will set the content-type in the HTML header. This is known to cause problems with some browsers and frameworks. If you are experiencing issues you can append _noheader to the format name and the data will be returned to you "RAW" with no headers being set. For instance you can could pass:

/i4a/api/json_noheader/membership.contact/24228 and it would return the same json data, but would not populate the HEADER that is returned to the calling page.

=== json ===
Json is a compact text based format, that at first glance looks somewhat like a traditional CSV file. It is becoming very popular with Web 2.0 and is used most often with AJAX.

=== xml ===

=== wddx ===
Wddx is nothing more than a specialized XML packet. It has a defined stucture in how the XML is organized, but otherwise it is identical to an XML document.

=== Links ===
* https://www.json.org/ - The source for information on json format
* https://en.wikipedia.org/wiki/JSON - Wikipedia article on json format
* https://en.wikipedia.org/wiki/XML - Wikipedia article on xml format
* https://en.wikipedia.org/wiki/Wddx - Wikipedia article on wddx format

[[Category:API]]

I4a api ColdFusion Example

2022-09-21T20:18:09Z

Andrea: Andrea moved page I4a api ColdFusion Example to I4A API ColdFusion Example

#REDIRECT [[I4A API ColdFusion Example]]

I4A API ColdFusion Example

2022-09-21T20:18:09Z

Andrea: Andrea moved page I4a api ColdFusion Example to I4A API ColdFusion Example

[[I4A API Guide]]

This example shows the basics of making a call to the API and returning the results.
<pre>
<source lang="cfm">
<Cfoutput>
<cfset wUrl = "http://www.mydomain.com/i4a/utilities/authenticate.cfc?wsdl">
<cfset username = "*********" />
<cfset password = "*******" />
<Cfset site_token = "*******-****-****-************" />
<cfset search_url = "http://www.mydomain.com/i4a/api/json/membership.contacts/lastname%20like%20l/" />

<cfset myConn = createObject("webservice",wUrl) />
<cfset admin = myConn.authenticateAdmin(username,password,site_token) />
<cfdump var ="#admin#" />
<cfset adminXML = xmlParse(admin) />
<Cfdump var="#adminXML#">
<Cfset authKey = adminXML.admin.XmlAttributes.authKey>
API URL=#search_url# 
<Cfhttp url="#search_url##authKey#" method="GET" result="result" charset="utf-8" />
<cfset contactJSON = result.FileContent />
<hr>Json Packet: 
<Cfdump var="#contactJSON#">
<hr>
<cfset contact = deserializejson(contactJSON) />
<cfdump var="#contact#" label="Decoded Json">

</Cfoutput>
</source>
</pre>
[[Category:API]]

I4A API ColdFusion Example

2022-09-21T20:17:50Z

Andrea:

Category:API

2022-09-21T20:17:22Z

Andrea: Created page with "API Pages"

API Pages

I4a API PHP Example

2022-09-21T20:15:15Z

Andrea:

I4A API Guide v1 Deprecated March 31, 2024

2022-09-21T20:14:49Z

Andrea:

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<yourwebsite.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.


== 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>https://<yourwebsite.com>/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://<yourwebsite.com>/i4a/api/json/membership.contacts/firstName like Rob/<authkey></pre>

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

* <nowiki>https://<yourwebsite.com>/i4a/api/</nowiki> - 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=john/ - returns records that match firstname=john
* /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 relevant 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]]'''

== Implemention Examples ==
* [[i4a api ColdFusion Example|ColdFusion Example]]
* [[i4a api PHP Example|PHP 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

2022-09-21T20:14:20Z

Andrea:

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<yourwebsite.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.


== 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>https://<yourwebsite.com>/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://<yourwebsite.com>/i4a/api/json/membership.contacts/firstName like Rob/<authkey></pre>

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

* <nowiki>https://<yourwebsite.com>/i4a/api/</nowiki> - 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=john/ - returns records that match firstname=john
* /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 relevant 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]]


== 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 ColdFusion Example

2022-09-21T20:13:58Z

Andrea:

[[I4A API Guide]]

This example shows the basics of making a call to the API and returning the results.

<source lang="cfm">
<Cfoutput>
<cfset wUrl = "http://www.mydomain.com/i4a/utilities/authenticate.cfc?wsdl">
<cfset username = "*********" />
<cfset password = "*******" />
<Cfset site_token = "*******-****-****-************" />
<cfset search_url = "http://www.mydomain.com/i4a/api/json/membership.contacts/lastname%20like%20l/" />

<cfset myConn = createObject("webservice",wUrl) />
<cfset admin = myConn.authenticateAdmin(username,password,site_token) />
<cfdump var ="#admin#" />
<cfset adminXML = xmlParse(admin) />
<Cfdump var="#adminXML#">
<Cfset authKey = adminXML.admin.XmlAttributes.authKey>
API URL=#search_url# 
<Cfhttp url="#search_url##authKey#" method="GET" result="result" charset="utf-8" />
<cfset contactJSON = result.FileContent />
<hr>Json Packet: 
<Cfdump var="#contactJSON#">
<hr>
<cfset contact = deserializejson(contactJSON) />
<cfdump var="#contact#" label="Decoded Json">

</Cfoutput>
</source>

[[Category:API]]

API Return Format

2022-09-21T20:12:22Z

Andrea:

[[I4A_api_guide]]

== Description ==
The API uses the REST methodology and can return data back to the sender in a number of formats. They are:

== Usage ==
Simply put the return format in the url string right after the /i4a/api/ part of the url. By default each format will set the content-type in the HTML header. This is known to cause problems with some browsers and frameworks. If you are experiencing issues you can append _noheader to the format name and the data will be returned to you "RAW" with no headers being set. For instance you can could pass:

/i4a/api/json_noheader/membership.contact/24228 and it would return the same json data, but would not populate the HEADER that is returned to the calling page.

=== json ===
Json is a compact text based format, that at first glance looks somewhat like a traditional CSV file. It is becoming very popular with Web 2.0 and is used most often with AJAX.

=== xml ===

=== wddx ===
Wddx is nothing more than a specialized XML packet. It has a defined stucture in how the XML is organized, but otherwise it is identical to an XML document.

=== Links ===
* https://www.json.org/ - The source for information on json format
* https://en.wikipedia.org/wiki/JSON - Wikipedia article on json format
* https://en.wikipedia.org/wiki/XML - Wikipedia article on xml format
* https://en.wikipedia.org/wiki/Wddx - Wikipedia article on wddx format

[[Category:API]]

Additional Examples

2022-09-21T20:12:03Z

Andrea:

==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]]

Main Page

2022-09-21T19:42:32Z

Andrea: /* Getting started */

'''Welcome to the I4A API Wiki.'''

I4a provides an API that allows you to access your data remotely and programmatically.

== Getting started ==
* [[I4A api guide]]

Main Page

2022-09-21T19:41:35Z

Andrea: /* Getting started */

'''Welcome to the I4A API Wiki.'''

I4a provides an API that allows you to access your data remotely and programmatically.

== Getting started ==
* [[I4A API Guide]]

I4A API Guide v1 Deprecated March 31, 2024

2022-09-21T19:40:08Z

Andrea: /* Syntax */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<yourwebsite.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.


== 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>https://<yourwebsite.com>/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://<yourwebsite.com>/i4a/api/json/membership.contacts/firstName like Rob/<authkey></pre>

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

* <nowiki>https://<yourwebsite.com>/i4a/api/</nowiki> - 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=john/ - returns records that match firstname=john
* /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 relevant 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]]


== 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]]

API Return Format

2022-09-21T19:24:27Z

Andrea: /* Links */

I4A API Guide v1 Deprecated March 31, 2024

2022-09-21T19:22:58Z

Andrea:

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<yourwebsite.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.


== 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>https://<yourwebsite.com>/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://<yourwebsite.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:

* <nowiki>https://<yourwebsite.com>/i4a/api/</nowiki> - 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=john/ - returns records that match firstname=john
* /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 relevant 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]]


== 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

2022-09-21T19:20:44Z

Andrea: /* Syntax */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<yoursite.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.


== 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>https://yourwebsite.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://yourwebsite.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:

* <nowiki>https://yourwebsite.com/i4a/api/</nowiki> - 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=john/ - returns records that match firstname=john
* /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 relevant 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]]


== 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

2022-09-21T19:19:11Z

Andrea: /* Syntax */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<yoursite.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.


== 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>https://yoursite.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://yoursite.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>https://yoursite.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=john/ - returns records that match firstname=john
* /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 relevant 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]]


== 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

2022-09-21T19:18:49Z

Andrea: /* REST Authentication */

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<yoursite.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.


== 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>https://site.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://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>https://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=john/ - returns records that match firstname=john
* /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 relevant 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]]


== 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

2022-09-21T19:16:05Z

Andrea:

= I4A API Guide =

== About ==

This guide will outline how to use the Internet4associations REST API.

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.

=== REST Authentication ===
REST is the preferred method of authenticating with your API.
To authenticate with REST you would simply navigate to:
* <pre>https://<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.

== 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>https://site.com/i4a/api/json/membership.contact/24228/<authkey></pre>

Another method could be:

<pre>https://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>https://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=john/ - returns records that match firstname=john
* /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 relevant 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]]


== 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

2011-11-03T15:47:24Z

Andrea:

= 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. This can come in one of 2 forms:
* 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.

Information is available on the [[API Settings]] page on how to obtain these values and update them if need be.

== 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</pre>

Another method could be:

<pre>http://site.com/i4a/api/json/membership.contacts/city like Chicago/</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 ==
None of these examples include the authKey that would be appended to the end of the string. It's assumed that it would be added to all of these in a real world scenario

* /i4a/api/json/membership.contact/24228 - Returns a json packet for contact record ID = 24228
* /i4a/api/xml/membership.contact/24228 - returns an xml packet for contact record ID = 24228
* /i4a/api/wddx/membership.contact/24228 - Returns a WDDX packet for contct record ID = 24228
* /i4a/api/json/view.All Contacts/lastname like L/ - 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/ - Same as above, but further filters by isActive = 1
* /i4a/api/json/membership.contacts/ - returns all records from the table related to the ORM object com.om.collections.membership.contacts.
* /i4a/api/json/view.ams_contact/ - 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]]