mirror of
https://github.com/internetee/registry.git
synced 2025-06-11 07:04:47 +02:00
Add registry lock documentation
This commit is contained in:
Maciej Szlosarczyk
parent
e2d2768b6e
commit
270444b2e8
3 changed files with 173 additions and 17 deletions
|
|
@ -1,22 +1,11 @@
|
||||||
# Registrant API integration specification
|
# Registrant API integration specification
|
||||||
|
|
||||||
REPP uses HTTP/1.1 protocol (http://tools.ietf.org/html/rfc2616) and
|
Test API endpoint: TBA
|
||||||
Basic Authentication (http://tools.ietf.org/html/rfc2617#section-2) using
|
|
||||||
Secure Transport (https://tools.ietf.org/html/rfc5246) with certificate and key
|
|
||||||
(https://tools.ietf.org/html/rfc5280).
|
|
||||||
|
|
||||||
Credentials and certificate are issued by EIS (in an exchange for desired API
|
|
||||||
username, CSR and IP).
|
|
||||||
|
|
||||||
To quickly test the API, use curl:
|
|
||||||
|
|
||||||
curl -q -k --cert user.crt.pem --key user.key.pem https://TBA/repp/v1/accounts/balance -u username:password
|
|
||||||
|
|
||||||
Test API endpoint: https://testepp.internet.ee/repp/v1
|
|
||||||
Production API endpoint: TBA
|
Production API endpoint: TBA
|
||||||
|
|
||||||
Main communication specification through Restful EPP (REPP):
|
Main communication specification through Registrant API:
|
||||||
|
|
||||||
[Authentication](registrant-api/v1/authentication.md)
|
[Authentication](registrant-api/v1/authentication.md)
|
||||||
[Domain related functions](registrant-api/v1/domain.md)
|
[Domains](registrant-api/v1/domain.md)
|
||||||
[Contact related functions](registrant-api/v1/contact.md)
|
[Domain Lock](registrant-api/v1/domain_lock.md)
|
||||||
|
[Contacts](registrant-api/v1/contact.md)
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
# Domain related actions
|
# Domain related actions
|
||||||
|
|
||||||
## GET /repp/v1/registrant/domains
|
## GET /repp/v1/registrant/domains
|
||||||
|
|
||||||
Returns domains of the current registrant.
|
Returns domains of the current registrant.
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -72,6 +73,7 @@ Content-Type: application/json
|
||||||
```
|
```
|
||||||
|
|
||||||
## GET repp/v1/registrant/domains
|
## GET repp/v1/registrant/domains
|
||||||
|
|
||||||
Returns domain names with offset.
|
Returns domain names with offset.
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -97,7 +99,8 @@ Content-Type: application/json
|
||||||
```
|
```
|
||||||
|
|
||||||
## GET repp/v1/registrant/domains/$UUID
|
## GET repp/v1/registrant/domains/$UUID
|
||||||
Returns domain names with offset.
|
|
||||||
|
Returns a single domain object.
|
||||||
|
|
||||||
|
|
||||||
#### Request
|
#### Request
|
||||||
|
|
|
||||||
164
doc/registrant-api/v1/domain_lock.md
Normal file
164
doc/registrant-api/v1/domain_lock.md
Normal file
|
|
@ -0,0 +1,164 @@
|
||||||
|
# Domain locks
|
||||||
|
|
||||||
|
## POST repp/v1/registrant/domains/$UUID/registry_lock
|
||||||
|
|
||||||
|
Set a registry lock on a domain.
|
||||||
|
|
||||||
|
#### Request
|
||||||
|
```
|
||||||
|
POST repp/v1/registrant/domains/98d1083a-8863-4153-93e4-caee4a013535/registry_lock HTTP/1.1
|
||||||
|
Accept: application/json
|
||||||
|
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
|
||||||
|
Content-Type: application/json
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Response for success
|
||||||
|
|
||||||
|
```
|
||||||
|
HTTP/1.1 200
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"uuid": "98d1083a-8863-4153-93e4-caee4a013535",
|
||||||
|
"name": "domain0.ee",
|
||||||
|
"registrar_id": 2,
|
||||||
|
"registered_at": "2015-09-09T09:11:14.861Z",
|
||||||
|
"status": null,
|
||||||
|
"valid_from": "2015-09-09T09:11:14.861Z",
|
||||||
|
"valid_to": "2016-09-09T09:11:14.861Z",
|
||||||
|
"registrant_id": 1,
|
||||||
|
"transfer_code": "98oiewslkfkd",
|
||||||
|
"created_at": "2015-09-09T09:11:14.861Z",
|
||||||
|
"updated_at": "2015-09-09T09:11:14.860Z",
|
||||||
|
"name_dirty": "domain0.ee",
|
||||||
|
"name_puny": "domain0.ee",
|
||||||
|
"period": 1,
|
||||||
|
"period_unit": "y",
|
||||||
|
"creator_str": null,
|
||||||
|
"updator_str": null,
|
||||||
|
"legacy_id": null,
|
||||||
|
"legacy_registrar_id": null,
|
||||||
|
"legacy_registrant_id": null,
|
||||||
|
"outzone_at": "2016-09-24T09:11:14.861Z",
|
||||||
|
"delete_at": "2016-10-24T09:11:14.861Z",
|
||||||
|
"registrant_verification_asked_at": null,
|
||||||
|
"registrant_verification_token": null,
|
||||||
|
"pending_json": {},
|
||||||
|
"force_delete_at": null,
|
||||||
|
"statuses": [
|
||||||
|
"clientUpdateProhibited",
|
||||||
|
"serverUpdateProhibited",
|
||||||
|
"serverTransferProhibited",
|
||||||
|
"serverDeleteProhibited",
|
||||||
|
],
|
||||||
|
"reserved": false,
|
||||||
|
"status_notes": {},
|
||||||
|
"statuses_backup": []
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Response for failure
|
||||||
|
|
||||||
|
```
|
||||||
|
HTTP/1.1 400
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"errors": [
|
||||||
|
{ "base": "domain cannot be locked" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
HTTP/1.1 404
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"errors": [
|
||||||
|
{ "base": "domain does not exist" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## DELETE repp/v1/registrant/domains/$UUID/registry_lock
|
||||||
|
|
||||||
|
Remove a registry lock.
|
||||||
|
|
||||||
|
#### Request
|
||||||
|
```
|
||||||
|
DELETE repp/v1/registrant/domains/98d1083a-8863-4153-93e4-caee4a013535/registry_lock HTTP/1.1
|
||||||
|
Accept: application/json
|
||||||
|
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
|
||||||
|
Content-Type: application/json
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Response for success
|
||||||
|
|
||||||
|
```
|
||||||
|
HTTP/1.1 200
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"uuid": "98d1083a-8863-4153-93e4-caee4a013535",
|
||||||
|
"name": "domain0.ee",
|
||||||
|
"registrar_id": 2,
|
||||||
|
"registered_at": "2015-09-09T09:11:14.861Z",
|
||||||
|
"status": null,
|
||||||
|
"valid_from": "2015-09-09T09:11:14.861Z",
|
||||||
|
"valid_to": "2016-09-09T09:11:14.861Z",
|
||||||
|
"registrant_id": 1,
|
||||||
|
"transfer_code": "98oiewslkfkd",
|
||||||
|
"created_at": "2015-09-09T09:11:14.861Z",
|
||||||
|
"updated_at": "2015-09-09T09:11:14.860Z",
|
||||||
|
"name_dirty": "domain0.ee",
|
||||||
|
"name_puny": "domain0.ee",
|
||||||
|
"period": 1,
|
||||||
|
"period_unit": "y",
|
||||||
|
"creator_str": null,
|
||||||
|
"updator_str": null,
|
||||||
|
"legacy_id": null,
|
||||||
|
"legacy_registrar_id": null,
|
||||||
|
"legacy_registrant_id": null,
|
||||||
|
"outzone_at": "2016-09-24T09:11:14.861Z",
|
||||||
|
"delete_at": "2016-10-24T09:11:14.861Z",
|
||||||
|
"registrant_verification_asked_at": null,
|
||||||
|
"registrant_verification_token": null,
|
||||||
|
"pending_json": {},
|
||||||
|
"force_delete_at": null,
|
||||||
|
"statuses": [
|
||||||
|
"ok"
|
||||||
|
],
|
||||||
|
"reserved": false,
|
||||||
|
"status_notes": {},
|
||||||
|
"statuses_backup": []
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Response for failure
|
||||||
|
|
||||||
|
```
|
||||||
|
HTTP/1.1 400
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"errors": [
|
||||||
|
{ "base": "domain cannot be unlocked" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
HTTP/1.1 404
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"errors": [
|
||||||
|
{ "base": "domain does not exist" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
Loading…
Add table
Add a link
Reference in a new issue