The Magic Website Factory is used to query for .Gent domain availability and to request domain registration and Indie Site setup.
The Magic Website Factory is being developed in conjunction with Combell, patrons of the .Gent top-level domain, and this specific instance is hosted by them on their infrastructure. The API presented here forms the public interface between Hallo.gent and Combell.
There is a development-time version of the Magic Website Factory used for local testing at https://source.ind.ie/indienet/magic-website-factory
All API calls require the passing of a secret that authenticates them. For the test server, this secret is hardcoded.
The API endpoints should be versioned, starting with the current version at
/v1. All locations, below, should be prefixed with the version identifier.
Check if the domain is available. Returns a JSON object with a boolean status.
Where the following known values for
domain returns the following responses:
On error, the server should return a valid error message.
Asks for the passed domain to be registered and for an Indie Site to be set up at it.
domain=<domain>: the domain to register
callback=<callback-url>: the callback URL to inform when the domain is ready
On successful registration of the domain and creation of the Indie Site, the Magic Website Factory carries out a PATCH request to the
callback URL passed in the Site service’s POST method with the following arguments:
<callback-url>/site/<domain>: domain to update the status for
?status=<code>: 201 = created, 409 = conflict (domain not available), 500 = internal server error (the site setup process failed and will not be retried)
The Magic Website Factory expects the following responses to its callback request: