I4A API 2.0 - Revision history

Felix2: /* Membership Endpoint */

2023-10-27T16:00:52Z

Membership Endpoint

← Older revision		Revision as of 11:00, 27 October 2023
Line 365:		Line 365:
	url --location --request POST 'https://yourdomain.com/i4a/api2/membership/' \		url --location --request POST 'https://yourdomain.com/i4a/api2/membership/' \
	--header 'authKey: XXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX' \		--header 'authKey: XXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX' \
	--header 'Content-Type: ~~application~~/~~json~~' \		--header 'Content-Type: multipart/form-data' \
	--form 'contactID="12345"'		--form 'contactID="12345"'
	</syntaxhighlight>		</syntaxhighlight>
Line 418:		Line 418:
	}		}
	</syntaxhighlight>		</syntaxhighlight>



	== Resources ==		== Resources ==

Felix2 at 15:59, 27 October 2023

2023-10-27T15:59:50Z

← Older revision		Revision as of 10:59, 27 October 2023
Line 419:		Line 419:
	</syntaxhighlight>		</syntaxhighlight>



			== Resources ==
			* [https://www.postman.com/ Postman] is a great tool to test and debug API calls.

	[[Category:API]]		[[Category:API]]

Felix2: /* Retrieving Data */

2023-10-27T12:25:15Z

Retrieving Data

← Older revision		Revision as of 07:25, 27 October 2023
Line 179:		Line 179:
	curl --location --request POST 'https://yourdomain.com/i4a/api2/contacts/' \		curl --location --request POST 'https://yourdomain.com/i4a/api2/contacts/' \
	--header 'authKey: XXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX' \		--header 'authKey: XXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX' \
	--header 'Content-Type: ~~application~~/~~json~~' \		--header 'Content-Type: multipart/form-data' \
	--form 'filter="lastName:Doe"'		--form 'filter="lastName:Doe"'
	</syntaxhighlight>		</syntaxhighlight>
Line 302:		Line 302:
	curl --location --request POST 'https://yourdomain.com/i4a/api2/views/' \		curl --location --request POST 'https://yourdomain.com/i4a/api2/views/' \
	--header 'authKey: XXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX' \		--header 'authKey: XXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX' \
	--header 'Content-Type: ~~application~~/~~json~~' \		--header 'Content-Type: multipart/form-data' \
	--form 'filter="TYPE IN ('\''Cash'\'', '\''Income'\'') AND title LIKE '\''%Membership%'\''"' \		--form 'filter="TYPE IN ('\''Cash'\'', '\''Income'\'') AND title LIKE '\''%Membership%'\''"' \
	--form 'view="chart of accounts"'		--form 'view="chart of accounts"'
Line 372:		Line 372:
	url --location --request POST 'https://yourdomain.com/i4a/api2/membership/' \		url --location --request POST 'https://yourdomain.com/i4a/api2/membership/' \
	--header 'authKey: XXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX' \		--header 'authKey: XXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX' \
	--header 'Content-Type: ~~application~~/~~json~~' \		--header 'Content-Type: multipart/form-data' \
	--form 'email="email@domain.com"'		--form 'email="email@domain.com"'
	</syntaxhighlight>		</syntaxhighlight>

Felix2: /* Contacts Endpoint */

2023-10-27T12:23:50Z

Contacts Endpoint

← Older revision		Revision as of 07:23, 27 October 2023
Line 99:		Line 99:
	curl --location --request POST 'https://yourdomain.com/i4a/api2/contacts/' \		curl --location --request POST 'https://yourdomain.com/i4a/api2/contacts/' \
	--header 'authKey: XXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX' \		--header 'authKey: XXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX' \
	--header 'Content-Type: ~~application~~/~~json~~' \		--header 'Content-Type: multipart/form-data' \
	--form 'filter="contactID:693681"'		--form 'filter="contactID:693681"'
	</syntaxhighlight>		</syntaxhighlight>

Felix2: /* Membership Endpoint */

2023-10-23T19:36:30Z

Membership Endpoint

← Older revision		Revision as of 14:36, 23 October 2023
Line 348:		Line 348:
	\| <code>Content-Type</code>		\| <code>Content-Type</code>
	<small>header \| optional</small>		<small>header \| optional</small>
	\| Set this to <code>application/x-www-form-urlencoded</code> or <code>~~application~~/~~json~~</code>.		\| Set this to <code>application/x-www-form-urlencoded</code> or <code>multipart/form-data</code>.
	\|-		\|-
	\| <code>contactID</code>		\| <code>contactID</code>

Felix2: /* Views Endpoint */

2023-10-23T19:36:13Z

Views Endpoint

← Older revision		Revision as of 14:36, 23 October 2023
Line 267:		Line 267:
	\| <code>Content-Type</code>		\| <code>Content-Type</code>
	<small>header \| optional</small>		<small>header \| optional</small>
	\| Set this to <code>application/x-www-form-urlencoded</code> or <code>~~application~~/~~json~~</code>.		\| Set this to <code>application/x-www-form-urlencoded</code> or <code>multipart/form-data</code>.
	\|-		\|-
	\| <code>view</code>		\| <code>view</code>

Felix2: /* Contacts Endpoint */

2023-10-23T19:35:51Z

Contacts Endpoint

← Older revision		Revision as of 14:35, 23 October 2023
Line 69:		Line 69:
	\| <code>Content-Type</code>		\| <code>Content-Type</code>
	<small>header \| optional</small>		<small>header \| optional</small>
	\| Set this to <code>application/x-www-form-urlencoded</code> or <code>~~application~~/~~json~~</code>.		\| Set this to <code>application/x-www-form-urlencoded</code> or <code>multipart/form-data</code>.
	\|-		\|-
	\| <code>filter</code>		\| <code>filter</code>

Felix2: /* Membership Endpoint */

2023-10-23T15:24:52Z

Membership Endpoint

← Older revision		Revision as of 10:24, 23 October 2023
Line 347:		Line 347:
	\|-		\|-
	\| <code>Content-Type</code>		\| <code>Content-Type</code>
	<small>header \| ~~required~~</small>		<small>header \| optional</small>
	\| Set this to <code>application/json</code>.		\| Set this to <code>application/x-www-form-urlencoded</code> or <code>application/json</code>.
	\|-		\|-
	\| <code>contactID</code>		\| <code>contactID</code>

Felix2: /* Views Endpoint */

2023-10-23T14:49:15Z

Views Endpoint

← Older revision		Revision as of 09:49, 23 October 2023
Line 266:		Line 266:
	\|-		\|-
	\| <code>Content-Type</code>		\| <code>Content-Type</code>
	<small>header \| ~~required~~</small>		<small>header \| optional</small>
	\| Set this to <code>application/json</code>.		\| Set this to <code>application/x-www-form-urlencoded</code> or <code>application/json</code>.
	\|-		\|-
	\| <code>view</code>		\| <code>view</code>
Line 333:		Line 333:
	}		}
	</syntaxhighlight>		</syntaxhighlight>



	=== Membership Endpoint ===		=== Membership Endpoint ===

Felix2: /* Contacts Endpoint */

2023-10-23T14:48:31Z

Contacts Endpoint

← Older revision		Revision as of 09:48, 23 October 2023
Line 68:		Line 68:
	\|-		\|-
	\| <code>Content-Type</code>		\| <code>Content-Type</code>
	<small>header \| ~~required~~</small>		<small>header \| optional</small>
	\| Set this to <code>application/json</code>.		\| Set this to <code>application/x-www-form-urlencoded</code> or <code>application/json</code>.
	\|-		\|-
	\| <code>filter</code>		\| <code>filter</code>