-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiary.apib
610 lines (452 loc) · 20.4 KB
/
apiary.apib
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
FORMAT: 1A
HOST: http://ticketstore.apphb.com/api/
# TicketStore
Bem-vindo,
Queremos que você conheça uma nova forma de vender ingressos online.
Você poderá integrar seu sistema com a plataforma TicketStore com total flexibilidade.
Veja a seguir a descrição dos principais recursos de nossa API:
## Informações Gerais
Este documento tem como objetivo descrever o funcionamento da API
aos desenvolvedores que desejam integrar outros sistemas à nossa plataforma.
Praticamente todas as operações realizadas através de
nossa API, podem ser feitas também pelo nosso site. A grande vantagem é que o
desenvolvedor poderá montar sua própria interface e unir em tempo real
as informações de outros sistemas com as informações da nossa plataforma.
Antes de acessar os métodos de criação de pedido, consulta de usuários ou
consulta de cartões de crédito do usuário, será necessária a autenticação
que gerará um código (`SecurityToken`) que deverá ser fornecido no `header`
de cada solicitação.
A nossa API interpreta a requisição e valida cada um dos campos enviados.
Quando houver algum campo com dado inválido, a API retornará
uma resposta contendo os campos inválidos e o motivo do erro.
## Códigos de Resposta HTTP
A nossa API valida os diversos campos e parâmetros enviados na requisição (request)
antes de prosseguir com o processamento da solicitação. Utilizamos os códigos HTTP
convencionados pela W3C para resposta das requisições, conforme tabela abaixo:
|Código | Nome | Descrição |
|--------|--------------------------|-----------------------------------------------------------------------|
| 200 |`OK` | Sucesso |
| 201 |`Created` | Criado |
| 400 |`Bad Request` | Requisição inválida (campos requeridos ou informados incorretamente |
| 401 |`Unauthorized` | Acesso ao recurso não autorizado |
| 404 |`Not Found` | Recurso não encontrado |
| 405 |`Method Not Allowed` | Método não permitido |
| 500 |`Internal Server Error` | Erro interno em nosso servidor |
## É hora de integrar!
Agora que já conhecer melhor o modelo de nossa API. Você já pode iniciar o
desenvolvimento de sua aplicação utilizando nosso ambiente.
# Group Acesso
Recurso para geração da chave de acesso (`SecurityToken`) aos recursos protegidos da
API.
## Autenticação [/access]
Permite criar `SecurityToken` com base nas credenciais do Usuário.
## Campos da Credencial
| Nome | Descrição |
|-------------------|-----------------------------------------------|
| `email` | E-mail do Usuário |
| `password` | Senha do Usuário |
### Criação do SecurityToken [POST]
+ Request (application/json)
+ Body
{
"email": "jose@email.com",
"password": "abc123"
}
+ Response 200 (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Request Credencial Inválida (application/json)
+ Body
{
"email": "jose@email.com",
"password": "senhainvalida"
}
+ Response 401 (application/json)
+ Body
{
"message": "User not authorized."
}
# Group Usuários
Recurso para manutenção de Usuários.
## Novo Usuário [/users]
Permite a criação de Usuários.
## Campos do Usuário
| Nome | Descrição |
|-------------------|-----------------------------------------------|
| `userId` | Identificador do Usuário |
| `name` | Nome completo do Usuário |
| `ssn` | CPF do Usuário |
| `gender` | Sexo do Usuário |
| `birthdate` | Data de Nascimento do Usuário |
| `email` | E-mail do Usuário |
| `password` | Senha do Usuário |
| `address.line1` | Endereço do Usuário |
| `address.line2` | Complemento do endereço do Usuário |
| `address.number` | Número do endereço do Usuário |
| `address.state` | Estado do Usuário |
| `address.city` | Cidade do Usuário |
| `address.zipCode` | CEP do Usuário |
### Criação de Usuário [POST]
+ Request (application/json)
+ Body
{
"name": "José da Silva",
"ssn": "12345678900",
"gender": "Male",
"address": {
"line1": "Rua das Flores",
"line2": "Apt. 25",
"number": "123",
"state": "RJ",
"city": "Rio de Janeiro",
"zipCode": "22123123"
},
"birthdate": "1981-04-21T00:00:00",
"email": "jose@email.com",
"password": "abc123",
}
+ Response 201 (application/json)
+ Body
{
"userId": 1,
"name": "José da Silva",
"ssn": "12345678900",
"gender": "Male",
"address": {
"line1": "Rua das Flores",
"line2": "Apt. 25",
"number": "123",
"state": "RJ",
"city": "Rio de Janeiro",
"zipCode": "22123123"
},
"birthdate": "1981-04-21T00:00:00",
"email": "jose@email.com"
}
+ Request Requisição Inválida (application/json)
+ Body
{
"ssn": "12345678900",
"gender": "Male",
"address": {
"line1": "Rua das Flores",
"line2": "Apt. 25",
"number": "123",
"state": "RJ",
"city": "Rio de Janeiro",
"zipCode": "22123123"
},
"birthdate": "1981-04-21T00:00:00",
"email": "jose@email.com",
"password": "abc123",
}
+ Response 400 (application/json)
+ Body
{
"message": "Invalid request.",
"errors": [
{
"source": "userViewModel",
"message": [
"Name is required."
]
}
]
}
## Usuário específico [/users/{id}]
Seleção de Usuário com base em seu identificador.
### Seleção de Usuário específico [GET]
+ Parameters
+ id (required, number, `1`) de um Usuário
+ Request
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Response 200 (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Body
{
"userId": 1,
"name": "José da Silva",
"ssn": "12345678900",
"gender": "Male",
"address": {
"line1": "Rua das Flores",
"line2": "Apt. 25",
"number": "123",
"state": "RJ",
"city": "Rio de Janeiro",
"zipCode": "22123123"
},
"birthdate": "1981-04-21T00:00:00",
"email": "jose@email.com"
}
+ Request Usuário Inexistente
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Response 404 (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Body
{
"message": "User not found."
}
## Cartões de Crédito do Usuário [/users/{id}/creditcards]
Seleção de cartões de crédito do Usuário.
### Seleção de Cartões de Crédito do Usuário [GET]
+ Parameters
+ id (required, number, `1`)
+ Request
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Response 200 (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Body
[
{
"creditCardId": 1,
"brand": "Visa",
"lastFourDigits": "1111",
"expMonth": 10,
"expYear": 2018
}
]
+ Request Usuário Inexistente
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Response 404 (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Body
{
"message": "User not found."
}
# Group Eventos
Recurso para manutenção de Eventos.
## Todos os Eventos [/events]
Permite a seleção de todos os Eventos.
## Campos do Evento
| Nome | Descrição |
|-------------------|-----------------------------------------------|
| `eventId` | Identificador do Evento |
| `name` | Nome completo do Evento |
| `description` | Descrição do Evento |
| `price` | Preço do Evento |
| `startDate` | Data de Início do Evento |
| `endDate` | Data de Término do Evento |
| `cardImageUrl` | Imagem da chamada do Evento |
| `location.line1` | Endereço do Evento |
| `location.line2` | Complemento da localização do Evento |
| `location.number` | Número da localização do Evento |
| `location.state` | Estado do Evento |
| `location.city` | Cidade do Evento |
| `location.zipCode`| CEP do Evento |
### Seleção de todos os Eventos [GET]
+ Request (application/json)
+ Header
+ Response 200 (application/json)
+ Header
+ Body
[
{
"eventId": 1,
"name": "Aprenda a Investir na Bolsa",
"description": "Neste curso passamos 10 ou 12 horas mostrando o ferramental dos mercados de renda variável, \r\n falamos sobre as bolsas de valores, sobre ações, opções, mercados futuros e fazemos uma introdução \r\n às duas escolas de análises: técnica e fundamentalista.",
"location": {
"line1": "Av. das Américas",
"line2": "Bloco 21, Sala 248 - Barra da Tijuca - Shopping Downtown",
"number": "500",
"state": "RJ",
"city": "Rio de Janeiro",
"zipCode": "22115456"
},
"price": 150,
"startDate": "2016-03-05T09:00:00",
"endDate": "2016-03-10T17:00:00",
"cardImageUrl": "http://ww2.baguete.com.br/admin//cache/sites/default/files/multimedia/imagens/noticia/92094-stock-market-rebounds-worst-day-year-read-more-http-business-time-com20130416stock-market-rebounds-w.jpg"
}
]
## Evento específico [/events/{id}]
Seleção de um Evento com base em seu identificador.
### Seleção de Evento específico [GET]
+ Parameters
+ id (required, number, `1`)... `id` de um evento
+ Response 200 (application/json)
+ Header
+ Body
{
"eventId": 1,
"name": "Aprenda a Investir na Bolsa",
"description": "Neste curso passamos 10 ou 12 horas mostrando o ferramental dos mercados de renda variável, \r\n falamos sobre as bolsas de valores, sobre ações, opções, mercados futuros e fazemos uma introdução \r\n às duas escolas de análises: técnica e fundamentalista.",
"location": {
"line1": "Av. das Américas",
"line2": "Bloco 21, Sala 248 - Barra da Tijuca - Shopping Downtown",
"number": "500",
"state": "RJ",
"city": "Rio de Janeiro",
"zipCode": "22115456"
},
"price": 150,
"startDate": "2016-03-05T09:00:00",
"endDate": "2016-03-10T17:00:00",
"cardImageUrl": "http://ww2.baguete.com.br/admin//cache/sites/default/files/multimedia/imagens/noticia/92094-stock-market-rebounds-worst-day-year-read-more-http-business-time-com20130416stock-market-rebounds-w.jpg"
}
+ Request Evento Inexistente
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Response 404 (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Body
{
"message": "Event not found."
}
# Group Pedidos
Recurso para manutenção de Pedidos.
## Novo Pedido [/orders]
Permite a criação de Pedidos.
> O formato da requisição pode ser de duas formas. Uma pode ser feita enviando
os dados de um novo cartão de crédito. A outra opção é enviando apenas o
identificador do cartão de crédito (`creditCardId`) do Usuário salvo em
compras anteriores.
## Campos do Pedido
| Nome | Descrição |
|-----------------------------------|-----------------------------------------------------------|
| `orderId` | Identificador do Pedido |
| `customer.userId` | Identificador do Comprador |
| `event.eventId` | Identificador do Evento |
| `quantity` | Quantidade de ingressos para o Evento |
| `paymentInfo.creditCardNumber` | Número do cartão de crédito |
| `paymentInfo.creditCardBrand` | Bandeira do cartão de crédito |
| `paymentInfo.expMonth` | Mês de validade do cartão de crédito |
| `paymentInfo.expYear` | Ano de validade do cartão de crédito |
| `paymentInfo.securityCode` | Código de segurança do cartão de crédito |
| `paymentInfo.holderName` | Nome do portador do cartão de crédito |
| `paymentInfo.saveCreditCard` | Opção para armazenar identificador do cartão de crédito |
| `paymentInfo.creditCardId` | Identificador do cartão de crédito já salvo |
### Criação de Pedido [POST]
+ Request Novo cartão de crédito (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Body
{
customer: {
userId: 26
},
event: {
eventId: 1
},
quantity: 2,
paymentInfo: {
creditCardNumber: "4111111111111111",
creditCardBrand: "Visa",
expMonth: 10,
expYear: 2018,
securityCode: 123,
holderName: "José da Silva",
saveCreditCard: true
}
}
+ Response 201 (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Body
{
"orderId": 1,
"event": {
"eventId": 1,
"name": "Aprenda a Investir na Bolsa",
"description": "Neste curso passamos 10 ou 12 horas mostrando o ferramental dos mercados de renda variável, \r\n falamos sobre as bolsas de valores, sobre ações, opções, mercados futuros e fazemos uma introdução \r\n às duas escolas de análises: técnica e fundamentalista.",
"location": {
"line1": "Av. das Américas",
"line2": "Bloco 21, Sala 248 - Barra da Tijuca - Shopping Downtown",
"number": "500",
"state": "RJ",
"city": "Rio de Janeiro",
"zipCode": "22115456"
},
"price": 150.00,
"startDate": "2016-03-05T09:00:00",
"endDate": "2016-03-10T17:00:00",
"cardImageUrl": "http://ww2.baguete.com.br/admin//cache/sites/default/files/multimedia/imagens/noticia/92094-stock-market-rebounds-worst-day-year-read-more-http-business-time-com20130416stock-market-rebounds-w.jpg"
},
"status": "Created",
"quantity": 2
}
+ Request Cartão de crédito salvo (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Body
{
customer: {
userId: 26
},
event: {
eventId: 1
},
quantity: 2,
paymentInfo: {
creditCardId: 1
}
}
+ Response 201 (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Body
{
"orderId": 1,
"event": {
"eventId": 1,
"name": "Aprenda a Investir na Bolsa",
"description": "Neste curso passamos 10 ou 12 horas mostrando o ferramental dos mercados de renda variável, \r\n falamos sobre as bolsas de valores, sobre ações, opções, mercados futuros e fazemos uma introdução \r\n às duas escolas de análises: técnica e fundamentalista.",
"location": {
"line1": "Av. das Américas",
"line2": "Bloco 21, Sala 248 - Barra da Tijuca - Shopping Downtown",
"number": "500",
"state": "RJ",
"city": "Rio de Janeiro",
"zipCode": "22115456"
},
"price": 150.00,
"startDate": "2016-03-05T09:00:00",
"endDate": "2016-03-10T17:00:00",
"cardImageUrl": "http://ww2.baguete.com.br/admin//cache/sites/default/files/multimedia/imagens/noticia/92094-stock-market-rebounds-worst-day-year-read-more-http-business-time-com20130416stock-market-rebounds-w.jpg"
},
"status": "Created",
"quantity": 2
}
+ Request Requisição Inválida (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Body
{
customer: {
userId: 26
},
quantity: 2,
paymentInfo: {
creditCardNumber: "4111111111111111",
creditCardBrand: "Visa",
expMonth: 10,
expYear: 2018,
securityCode: 123,
holderName: "José da Silva",
saveCreditCard: true
}
}
+ Response 400 (application/json)
+ Header
SecurityToken: dXNlcjpwYXNzd29yZA==
+ Body
{
"message": "Invalid request.",
"errors": [
{
"source": "orderViewModel",
"message": [
"Event is required."
]
}
]
}