Difference between revisions of "Internal API"
From ITR Wiki
| Line 7: | Line 7: | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| − | ! Endpoint !! Role !! Description | + | ! Endpoint !! Role !! Description !! Headers |
|- | |- | ||
| test || All || Standard test page | | test || All || Standard test page | ||
| Line 13: | Line 13: | ||
| copyright || All || Return the copyright information for this ITR installation | | copyright || All || Return the copyright information for this ITR installation | ||
|- | |- | ||
| − | + | | companyname || All || Return the company name for this ITR installation | |
| + | |- | ||
| + | | login || All || Login endpoint || UserID, Password, CompanyID (optional) | ||
| + | |- | ||
|} | |} | ||
Revision as of 09:09, 29 March 2019
Internal API
The internal API is for usage by the website of the ITR. It cannot be used from external websites, unless the flag ENABLE_CORS in the file instance/application.cfg is set to 'Y'. It is strongly discouraged to set this flag to 'Y' for anything else but developmnet systems.
The following API calls are available for the following roles
| Endpoint | Role | Description | Headers |
|---|---|---|---|
| test | All | Standard test page | |
| copyright | All | Return the copyright information for this ITR installation | |
| companyname | All | Return the company name for this ITR installation | |
| login | All | Login endpoint | UserID, Password, CompanyID (optional) |
