-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathoverview-javadoc.html
74 lines (66 loc) · 2.99 KB
/
overview-javadoc.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<html>
<head><title>jPostmon - Cliente Java para o Postmon API</title></head>
<body>
<h1>jPostmon - Cliente Java para a API Postmon</h1>
<p>Essa documentação é reference a biblioteca jPostmon, um cliente da API Postmon, que trata de
endereçamento e entrega no Brasil.
<br>Para maiores informações sobre a API, projetos relacionados e issues, visite a página do
<a href="https://github.com/PostmonAPI/postmon">Postmon API no GitHub</a>.
<br>Para assuntos relacionados especificamente com o jPostmon, visite a página do projeto do
<a href="https://github.com/PostmonAPI/postmon-java">jPostmon no GitHub</a>.</p>
<h2>Realizando consultas a Postmon API</h2>
<p>As consultas de CEP e rastreamento de encomendas dos Correios brasileiros, são feitas a
partir da classe <a href="br/com/postmon/jpostmon/Postmon.html">Postmon</a>.
<br>Veja abaixo exemplo de consulta de CEP:</p>
<pre> Endereco endereco = null;
try {
endereco = Postmon.consultar(Consultas.CEP)
.cep("01011100")
.buscar();
} catch (InvalidParameterException e) {
//Erro quando o CEP não é informado corretamente
} catch (PostmonAPIException e) {
//Algum erro na comunicação com a API
}
if (endereco != null) {
//CEP encontrado
System.out.println(endereco.toString());
} else {
/*
* CEP NÃO encontrado. Trate a situação como achar melhor.
*/
}</pre>
<p>Exemplo de rastreamento de um código dos Correios:</p>
<pre> Rastreamento rastreio = null;
try {
rastreio = Postmon.consultar(Consultas.RASTREIO)
.entidade(Consultas.Entidade.ECT)
.codigo("RC227774716CN")
.rastrear();
} catch (InvalidParameterException e) {
//Erro quando o código não é informado
} catch (PostmonAPIException e) {
//Algum erro na comunicação com a API.
}
if (endereco != null) {
//Código de rastreamento encontrado
System.out.println(rastreio.toString());
} else {
/*
* Código de Rastreamento NÃO encontrado. Trate a situação como achar melhor.
*/
}</pre>
<h2>Como incluir a jPostmon em seu projeto</h2>
<p>O jPostmon já está disponível através do repositório Sonatype OSS e é possível utilizar como
dependência em um projeto Maven. Basta adicionar ao seu projeto:
<pre> <dependency>
<groupId>br.com.postmon</groupId>
<artifactId>jpostmon</artifactId>
<version>1.0.0</version>
</dependency></pre>
<p>Também é possível fazer o download do JAR diretamente do repositório. Faça o download da
<a href="https://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=br.com.postmon&a=jpostmon&v=1.0.0&e=jar">
distribuição binária (JAR)</a> e adicionar ao seu projeto da maneira com a qual já está
acostumado.
</body>
</html>