Add domain list documentation

This commit is contained in:
Maciej Szlosarczyk 2018-07-13 16:19:34 +03:00
parent 29e06d83c0
commit d49b4b5c0f
No known key found for this signature in database
GPG key ID: 41D62D42D3B0D765
3 changed files with 106 additions and 6 deletions

View file

@ -17,8 +17,6 @@ Production API endpoint: TBA
Main communication specification through Restful EPP (REPP): Main communication specification through Restful EPP (REPP):
[Contact related functions](repp/v1/contact.md) [Authentication](registrant-api/v1/authentication.md)
[Domain related functions](repp/v1/domain.md) [Domain related functions](registrant-api/v1/domain.md)
[Domain transfers](repp/v1/domain_transfers.md) [Contact related functions](registrant-api/v1/contact.md)
[Account related functions](repp/v1/account.md)
[Nameservers](repp/v1/nameservers.md)

View file

@ -7,7 +7,7 @@ authentication. API client should perform authentication with eID according to
the approriate documentation, and then pass on values from the webserver's the approriate documentation, and then pass on values from the webserver's
certificate to the API server. certificate to the API server.
## POST /repp/v1/auth/eid/token ## POST /repp/v1/registrant/auth/eid/token
Returns a bearer token to be used for further API requests. Tokens are valid for 2 hours since their creation. Returns a bearer token to be used for further API requests. Tokens are valid for 2 hours since their creation.

View file

@ -0,0 +1,102 @@
# Domain related actions
## GET /repp/v1/registrant/domains
Returns domains of the current registrar.
#### Parameters
| Field name | Required | Type | Allowed values | Description |
| ---------- | -------- | ---- | -------------- | ----------- |
| limit | false | Integer | [1..200] | How many domains to show |
| offset | false | Integer | | Domain number to start at |
| details | false | String | ["true", "false"] | Whether to include details |
#### Request
```
GET repp/v1/registrant/domains?limit=1&details=true HTTP/1.1
Accept: application/json
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
Content-Length: 0
Content-Type: application/json
```
#### Response
```
HTTP/1.1 200
Cache-Control: max-age=0, private, must-revalidate
Content-Length: 808
Content-Type: application/json
{
"domains": [
{
"id": 1,
"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": [
]
}
],
"total_number_of_records": 2
}
```
## GET repp/v1/registrant/domains
Returns domain names with offset.
#### Request
```
GET repp/v1/registrant/domains?offset=1 HTTP/1.1
Accept: application/json
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
Content-Length: 0
Content-Type: application/json
```
#### Response
```
HTTP/1.1 200
Cache-Control: max-age=0, private, must-revalidate
Content-Length: 54
Content-Type: application/json
{
"domains": [
"domain1.ee"
],
"total_number_of_records": 2
}
```