I4A API 2.0: Difference between revisions
Jump to navigation
Jump to search
| Line 2: | Line 2: | ||
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. | 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 === | ||
'''Example''': | '''Example''': | ||
| Line 23: | Line 23: | ||
Once you have successfully obtained the '''authKey''', you can then access a few different endpoints. | Once you have successfully obtained the '''authKey''', you can then access a few different endpoints. | ||
=== Contacts Endpoint === | === Contacts Endpoint === | ||
Revision as of 13:56, 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
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": ""
}
Once you have successfully obtained the authKey, you can then access a few different endpoints.
Contacts Endpoint
POST /i4a/api2/contacts/