Installation guide

Connect through the REST API

Integrate HTQLDB from any supported HTTP client.

View API reference
  1. Review the API contract

    Choose an endpoint and review the request and response schema.

    ItemDescription
    EndpointA documented resource and operation.
    RequestThe expected parameters and structure.
    ResponseThe returned structure as defined in the documentation.
  2. Configure authorised access

    Use credentials and scopes provisioned for your environment. Never expose secrets in client code.

    ItemDescription
    CredentialsUse the credentials provisioned for your environment.
    ScopesRequest only the scopes required for the operation.
    SecurityKeep secrets secure and out of client code.
  3. Send a test request

    Use a documented endpoint and permitted operation.

    ItemDescription
    HTTP methodUse the method specified in the documentation.
    Request payloadProvide parameters or a body as documented.
    ClientUse any supported HTTP client (e.g. curl, scripting, or SDK).
  4. Handle the response

    Check HTTP status and the documented error structure.

    ItemDescription
    HTTP statusCheck the status code and follow the documented handling.
    Response bodyRead and process the response as defined in the documentation.
    ErrorsUse the documented error structure to handle failures.