I4A API 2.0: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 9: | Line 9: | ||
=== Parameters === <!--T:43--> | === Parameters === <!--T:43--> | ||
{| class="wikitable" style="width: 100%;" | {| class="wikitable" style="width: 100%;" | ||
|style="width: 20%;"|<code>q</code> | |style="width: 20%;"|<code>q</code> | ||
| Line 19: | Line 18: | ||
| <translate><!--T:45--> Maximum number of search results to return, between 1 and 100. Default: 50</translate> | | <translate><!--T:45--> Maximum number of search results to return, between 1 and 100. Default: 50</translate> | ||
|} | |} | ||
| Line 41: | Line 39: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== Retrieving Data == | == Retrieving Data == | ||
Revision as of 14:23, 26 October 2022
Security
For security purposes, I4A API 2 will only work on a secure port through HTTPS. To access any of the API functionality, you must first authenticate. Information is available on the API Settings page on how to obtain the values needed to authenticate and update them, if need be.
Authentication Endpoint
POST /i4a/api2/authenticate/
Parameters
q
required | query |
<translate> Search terms</translate> |
limit
optional | query |
<translate> Maximum number of search results to return, between 1 and 100. Default: 50</translate> |
Example:
curl --location --request POST 'https://<yourdomain.com>/i4a/api2/authenticate' \
--form 'username="XXXXXXXX"' \
--form 'password="XXXXXXXX"' \
--form 'token="XXXXXX-XXXX-XXXXX-XXXXXXXXXXX"'
Response:
{
"expiration": "{ts '2022-10-25 16:03:47'}",
"success": true,
"authKey": "XXXXXX-XXXX-XXXXX-XXXXXXXXXXX",
"error": ""
}
Retrieving Data
Once you have successfully obtained the authKey, you can then access a few different read-only endpoints. Note: Your authKey will expire after 4 hours.
Contacts Endpoint
POST /i4a/api2/contacts/
Views Endpoint
POST /i4a/api2/views/