Web2/Web3 Mirroring API
Our REST API service has five distinct types of controllers:
Authentication
For the authentication we only have a POST request used to log in the user with the right credentials in order to obtain an access token. The request user body includes a username and password. The authentication token is valid for one month.
Type
Description
POST
Logs in the user in order to obtain an access token. The request body includes a username and password.
Zones
Within the zone, our services encompass six GET requests, along with a single POST, PUT, and PATCH request each.
Type
Description
GET
Retrieve the following information:
a zone by UUID
all zones
all zones of logged user
zones with a specific name, status, or associated profile registry
check name availability
search zone based on criteria
POST
Creates a zone using the provided information.
PUT
Update a zone using the provided information.
PATCH
Transfer zone from one registrar/registrant to another.
As of now, the zone stores information regarding its status. We currently recognize four status types:
OK - The zone is operational.
INACTIVE - The zone is not in operation.
PENDING - The zone is expiring and will soon become inactive.
ERROR - Denotes an issue with the zone's operation.
Users
Users can access only four GET requests, as we only allow to read information of a user from our api, while all other settings are handled through Auth0.
Type
Description
GET
Fetch user by uuid
Fetch list of users
Fetch current logged in user
Fetch user by username and role
Records
For records we have one of GET, POST, PUT and DELETE request.
Type
Description
GET
Fetch a record by UUID.
POST
Create records using the provided zone and a list of records (a record can't exist without a zone).
PUT
Update records based on the provided data.
DELETE
Delete a record by UUID.
Profile registries
In this case we have three GET requests, one POST and one PUT request.
Type
Description
GET
Fetch the following information:
profile registries by uuid
all profile registries
profile registries by type
POST
Create a profile registry using the provided data
PUT
Update a profile registry by uuid using the provided data
Pagination
The API's default settings are as follows:
Page number: 0
Page size: 25
Sorting: by name
Users have the flexibility to customise and adjust these values to meet their specific requirements. For instance, they can pick the first page and set the amount of pages to retrieve to a lower or higher number, as well as decide a different type of ordering (such as by creation date).
Last updated