Skip to content
  • There are no suggestions because the search field is empty.

How do I use the SILQ API

SILQ allows API access for certain plans, and supports a full OAuth2 token flow that provides a token that can then be used as with subsequent API calls.

To integrate with SILQ, what you need to do is the following.

API access is only available on the Barrister Expert and Solicitor Expert plans

    • If you are a third party developer and do not have a SILQ account already, go to https://online.silq.com.au/#/sign-up and create an account following that process. This will create a free 14 days trial of the software, but you can apply for that to be extended if need be.
    • Once you have an account go to https://api.silq.online/openapi/index.html#/ for details on our API.
    • You will need to register an app in our OAuth2 system using the oauth2/apps endpoint.
      • Currently we don't have an UI to register an App in SILQ, so it must be done using the oauth2/apps endpoint. We recommend you use a tool such as Postman to execute the request top register the app.
      • This only needs to be done once.
      • Make sure your store you client id and secret as the secret will only be sent to you when the app is created, but you can generate a new secret by updating the app with the REGENERATECLIENTSECRET:true parameter.
      • You can register up to 3 redirect URLs.
      • It will return also an APIKEY (ApiGatewayApiKeyId) which will be needed to be passed to the API as a header (X-API-KEY) in the near future.
    • Once the app is created you can then use the oauth2/token and oauth2/authorise endpoints to acquire an OAuth2 token using a standard OAuth2 flow. That token can then be used with the API. Tokens expire after 1 hour and after that you will need to refresh the token using the RefreshToken to acquire a new token.
    • When calling an API you will need to provide the OAuth2 token as an Authorization header (and soon you will need to provide the X-API-KEY header as well) Any token that you create will be tied to the X-API-Key for your app so will not work without it.
    • Currently we have only documented a limited number of end-points. If there are other features of SILQ that you would like to have API access to, please contact support@silq.com.au