I4A API 2.0: Difference between revisions

From i4a API Wiki
Jump to navigation Jump to search
Line 14: Line 14:


'''Response:'''
'''Response:'''
<syntaxhighlight lang="json">
{
    "expiration": "{ts '2022-10-25 16:03:47'}",
    "success": true,
    "authKey": "6A08FCBC-E8B7-1061-88BF09FF8135D15F",
    "error": ""
}
</syntaxhighlight>

Revision as of 13:32, 26 October 2022

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

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": "6A08FCBC-E8B7-1061-88BF09FF8135D15F",
    "error": ""
}