Realtime Register

This page assists you in implementing ADAC to your webshop. There are several ways to integrate ADAC within your webshops. Namely, using our TypeScript client or by connecting directly to the ADAC API.

The ADAC API has these actions:

Input - Check if a domain name is available, also retrieves suggestions if there are any suggestion tools active
Categories - Fetch available categories
Check - Check a single domain
Suggest - Generate suggestions based on a input

Implementing using the TypeScript client EASY

This TypeScript client is designed to work with Node.js environments and modern JavaScript frameworks like Vue.js & React.

You can find an example on how to implement this on our GitHub page

Implementing via the ADAC API INTERMEDIATE

The ADAC API has two entry points, one for a WebSocket connection and one for XMLHttpRequests (AJAX calls). We highly recommend the WebSocket, the AJAX endpoint is only provided to support legacy browsers that do not support WebSockets.

WebSockets: wss://adac.api.yoursrs.com/ws - All commands and responses are sent as json messages through a WebSockets.
REST: https://adac.api.yoursrs.com/action - Commands are sent as POST request with json contents, all the responses are streamed back over the open connection using Transfer-Encoding: chunked until the action is completed. This method is useful when you opt to implement ADAC in a middleware layer instead of the frontend.
- Warning: Support for streaming json responses is dependent on the used HTTP client and response handling, when the response handled as a stream the results will only become available after all checks have completed and the connection is closed. This can result in much slower response times to your clients.
- No session_id parameter is used for this method, each request is treated as a standalone request.
DEPRECATED XMLHttpRequests: https://adac.api.yoursrs.com/ajax - Commands are sent as POST request with json contents, the response does not contain any data. To retrieve responses you open a GET request in a loop to fetch new responses from the API (long-polling), a single response may contain zero, one or multiple response entries.

Implementing using the JavaScript client DEPRECATED

First, add the ADAC client to the body of your webshop. Preferably on the bottom, this ensures that all elements are loaded before loading ADAC.

<script src="https://adac.api.yoursrs.com/static/client.js"></script>

Then, add the following snippet and fill in the API_KEY and TLD_SET_TOKEN (you can find your API_KEY and a TLD_SET_TOKEN in the ADAC Management Panel).

<script>
    const API_KEY = '{YOUR_API_KEY}';
    adac.initialize(API_KEY, {
      TLD_SET_TOKEN: '{A_TLD_SET_TOKEN}'
    });
</script>

Now add either the following elements to your page:

<input id="adac-js-domain-input" type="text" >
<div id="adac-js-categories"></div>
<div id="adac-js-domain-results"></div>
<div id="adac-js-suggestions"></div>

Or set your own custom elements by overwriting the inputElement, resultsElement, suggestionElement and categoriesElement parameters during initialization e.g.:

<script>
    const API_KEY = '{YOUR_API_KEY}';
    adac.initialize(API_KEY, {
      TLD_SET_TOKEN: '{A_TLD_SET_TOKEN}',
      inputElement: document.getElementById('your-custom-input-id'),
      resultsElement: document.getElementById('your-custom-results-element-id'),
      suggestionElement: document.getElementById('your-custom-suggestion-element-id'),
      categoriesElement: document.getElementById('your-custom-categories-element-id')
    });
</script>