Skip to content

Commit b49f003

Browse files
authored
Update README.md
Signed-off-by: Bruno Hashimoto <bgmuniz@live.com>
1 parent 45ff3b0 commit b49f003

File tree

1 file changed

+70
-41
lines changed

1 file changed

+70
-41
lines changed

README.md

Lines changed: 70 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,25 @@
88

99
## Recursos da API
1010

11-
A API utiliza o método **GET** para listar os dados dos hosts, fornecendo informações detalhadas sobre cada domínio, incluindo seu nome, DNS, protocolos suportados, IPs associados e dados de regulamentação da Anatel.
1211

13-
## Endpoint da API
12+
## Iniciando uma resolução
13+
14+
### [POST] Start
15+
16+
Para iniciar uma resolução utilize
17+
18+
```bash
19+
curl --location "https://bet-blocker.com/api/v1/start"
20+
```
21+
22+
Feito isso o sistema irá iniciar um job para gerar as resoluções para cada domínio informado.
23+
24+
Importante mencionar que após iniciado não será possível interromper ou começar outro, será possível iniciar uma resolução por dia.
25+
26+
Após gerado acesse o endpoint [GET] DNS.
27+
28+
### [GET] DNS
29+
A API utiliza o método **GET** para listar os dados dos hosts, fornecendo informações detalhadas sobre cada domínio, incluindo seu nome, DNS, protocolos suportados, IPs associados e dados de regulamentação da Anatel.
1430

1531
Sendo a data do dia: exemplo 09-11-2024.json
1632

@@ -26,48 +42,61 @@ https://bet-blocker.com/api/v1/dns?date=11-11-2024
2642
```
2743
### Estrutura de retorno previsto (Callback)
2844

29-
Abaixo, a estrutura de dados retornada pela API:
45+
Abaixo, o contrato retornada pela API:
3046

31-
```json
47+
```bash
48+
public class ResponseHostDto
3249
{
33-
"Date": "09-11-2024",
34-
"ResolvedHosts": [
50+
public class ResponseHostsDTO
51+
{
52+
public string? Name { get; set; }
53+
public string? Host { get; set; }
54+
public Dns? DNS { get; set; }
55+
public Protocols Protocols { get; set; }
56+
public Ips Ips { get; set; }
57+
public Anatel Anatel { get; set; }
58+
}
59+
60+
public class Anatel
61+
{
62+
public AnatelInfo AnatelInfo { get; set; }
63+
public DateTime CheckedAt { get; set; }
64+
public DateTime InsertAt { get; set; }
65+
public DateTime UpdatedAt { get; set; }
66+
}
67+
68+
public class AnatelInfo
69+
{
70+
public string? UrlFull { get; set; }
71+
public string? Url { get; set; }
72+
public string? File { get; set; }
73+
public string? Date { get; set; }
74+
public string? Hour { get; set; }
75+
public string? Mime { get; set; }
76+
}
77+
78+
public class Ips
79+
{
80+
public string? Ip { get; set; }
81+
public DateTime ResolvedAt { get; set; }
82+
}
83+
84+
public class Protocols
85+
{
86+
public bool Https { get; set; }
87+
public bool Http { get; set; }
88+
}
89+
90+
public class Dns
3591
{
36-
"Name": "a5sbet.com",
37-
"Host": "a5sbet.com",
38-
"DNS": {
39-
"Type": "InterNetwork",
40-
"Name": "a5sbet.com",
41-
"Host": "a5sbet.com",
42-
"ReverseDns": "104.21.42.168",
43-
"CanonicalName": "a5sbet.com",
44-
"TTl": "3600",
45-
"ResolvedAt": "2024-11-09T17:48:37.149205Z"
46-
},
47-
"Protocols": {
48-
"Https": true,
49-
"Http": true
50-
},
51-
"Ips": {
52-
"Ip": "104.21.42.168",
53-
"ResolvedAt": "2024-11-09T17:48:37.149204Z"
54-
},
55-
"Anatel": {
56-
"AnatelInfo": {
57-
"UrlFull": null,
58-
"Url": null,
59-
"File": null,
60-
"Date": "11/9/2024",
61-
"Hour": "5:48PM",
62-
"Mime": "application/json"
63-
},
64-
"CheckedAt": "2024-11-09T17:48:13.770764Z",
65-
"InsertAt": "2024-11-09T17:48:13.770765Z",
66-
"UpdatedAt": "2024-11-09T17:48:13.770765Z"
67-
}
68-
},
69-
.......
70-
]
92+
public string? Type { get; set; }
93+
public string? Name { get; set; }
94+
public string? Host { get; set; }
95+
public string? ReverseDns { get; set; }
96+
public string? CanonicalName { get; set; }
97+
public string? TTl { get; set; }
98+
public DateTime ResolvedAt { get; set; }
99+
}
71100
}
72101
```
73102

0 commit comments

Comments
 (0)