Licensing
The REST API is a licensed component of the Xytech Application Server.
Information You Will Need
To connect with the REST API, you will need to know the instance details:
| Detail | e.g. | Comment |
|---|---|---|
| Site Base URL | https://example.com | This is the same base URL you use to access your system |
| Database Name | DEMO1 | Instance database name |
API URL
The API URL is constructed as follows:
https://{Site Base_URLl}/API/v2/database/{dbname}/{endpoint}
e.g. https://example.com/mysite/API/v2/database/demo/JmJob
For systems installed prior to mid-2023, you may also require the port number. All later systems are now set up with a proxy to avoid the need to know the port number.
If you do not have this information, please contact Xytech Technical Support.
API Users & Permissions
An API user needs to have been created as a user in the Platform. The user, must be enabled for REST API access by flagging 'Allow API Login' on the user setup.
As with all users, assign appropriate security roles (enable as a super user is not recommended).
Authenticating
Basic Authentication
The REST API uses Basic Authentication and will require a login account.
Always use HTTPS encrypted protocol when communicating with the REST API to ensure credentials are not passed in clear text.