-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtixbase_api.yml
1032 lines (991 loc) · 26.2 KB
/
tixbase_api.yml
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
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Tixbase Core API
description: |
# Introduction
Welcome to the Tixbase Core API - a comprehensive white label ticketing solution that enables organizations to manage events and tickets with blockchain integration.
This API provides complete functionality for:
- Event creation and management
- Primary ticket sales processing
- Secondary market ticket operations
- NFT-backed ticket creation and validation
- Secure resale mechanisms
# Authentication
All API endpoints require authentication using an organization-specific API key. Include your API key in the request header:
```
x-api-key: tixbase_<your-api-key>
```
example: tixbase_f55fe43c5bcf40345f64dd78d7575e7426e1622a8bdd45e7f693c843265c007c
# Environments
- Development: https://api-dev.tixbase.io/api/v1
- Production: https://api-prod.tixbase.io/api/v1
version: 1.0.0
servers:
- url: https://api-dev.tixbase.io/api/v1
description: Development server
- url: https://api-prod.tixbase.io/api/v1
description: Production server
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: Organization API key in format 'tixbase_<hash>'
schemas:
Organization:
type: object
properties:
name:
type: string
description: Name of the organization
slug:
type: string
description: URL-friendly identifier for the organization
dontReplayEmailAddress:
type: string
format: email
example: [email protected]
description: Email address for do-not-replay functionality
oauth2:
type: object
properties:
accessTokenUrl:
type: string
description: URL for OAuth2 token request
userUrl:
type: string
description: URL for user information request
required:
- accessTokenUrl
- userUrl
required:
- name
- slug
- dontReplayEmailAddress
- oauth2
OrganizationResponse:
type: object
properties:
organizationId:
type: string
name:
type: string
slug:
type: string
apiKey:
type: string
expiresAt:
type: string
format: date-time
oauth2ClientSecret:
type: string
Event:
type: object
properties:
externalEventId:
type: string
description: Client's own event identifier
name:
type: string
description: Name of the event
date:
type: string
format: date-time
eventType:
type: string
enum: [seated, general_admission]
description: Type of event seating arrangement
example: "seated"
endTime:
type: string
format: date-time
eventCategory:
type: string
enum: [football, music, performing_arts, sports, museum, other]
venueName:
type: string
venueAddress:
type: string
description:
type: string
purchaseLimit:
type: integer
minimum: 1
eventImage:
type: string
description: Base64 encoded image
maxTickets:
type: integer
minimum: 1
resaleEnabled:
type: boolean
price:
type: number
minimum: 0
ticketCategories:
type: array
items:
type: object
properties:
name:
type: string
price:
type: number
minimum: 0
maxTickets:
type: integer
minimum: 1
required:
- name
- price
required:
- externalEventId
- name
- date
- eventType
Ticket:
type: object
properties:
_id:
type: string
description: External ticket identifier
eventId:
type: string
description: ID of the associated event
seat:
type: string
description: Seat number (if seated event, else null)
row:
type: string
description: Row number (if seated event, else null)
ownerId:
type: string
description: ID of the ticket owner
ownerEmail:
type: string
format: email
description: Email of the ticket owner
categoryName:
type: string
description: Name of the ticket category
required:
- _id
- eventId
- ownerId
- ownerEmail
- categoryName
Tickets:
type: object
properties:
ownerId:
type: string
ownerEmail:
type: string
eventId:
type: string
tickets:
type: array
items:
type: object
properties:
ticketId:
type: string
row:
type: string
description: Row number (if seated event, else null)
seat:
type: string
description: Seat number (if seated event, else null)
categoryName:
type: string
description: Name of the ticket category
BurnTicket:
type: object
properties:
ticketId:
type: string
seat:
type: string
description: Seat number (if seated event, else null)
row:
type: string
description: Row number (if seated event, else null)
BurnTickets:
type: object
properties:
ownerId:
type: string
eventId:
type: string
tickets:
type: array
items:
type: object
properties:
ticketId:
type: string
description: UUID of the ticket to burn
row:
type: string
description: Row number (if seated event, else null)
seat:
type: string
description: Seat number (if seated event, else null)
categoryName:
type: string
description: Name of the ticket category
TicketListing:
type: object
properties:
ticketId:
type: string
price:
type: number
duration:
type: integer
description: Duration of the listing in days
required:
- ticketId
- price
- duration
TicketEdit:
type: object
properties:
ticketId:
type: string
newPrice:
type: number
required:
- ticketId
- newPrice
TicketDelist:
type: object
properties:
ticketId:
type: string
required:
- ticketId
Code:
type: object
properties:
code:
type: string
description: Authorization code for OAuth2 flow
redirectUri:
type: string
description: Redirect URI for OAuth2 flow
required:
- code
- redirectUri
paths:
/organizations:
post:
summary: Create a new organization
description: Creates a new organization and generates an API key
tags:
- Organizations
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Organization"
responses:
"201":
description: Organization created successfully
content:
application/json:
schema:
$ref: "#/components/schemas/OrganizationResponse"
"400":
description: Invalid input parameters
"500":
description: Internal server error
/events:
get:
summary: Get organization events
description: Retrieves all events for the authenticated organization
tags:
- Events
security:
- ApiKeyAuth: []
responses:
"200":
description: List of events retrieved successfully
content:
application/json:
schema:
type: array
items:
type: object
properties:
eventId:
type: string
organizationId:
type: string
externalEventId:
type: string
name:
type: string
date:
type: string
format: date-time
endTime:
type: string
format: date-time
eventCategory:
type: string
enum:
[
football,
music,
performing_arts,
sports,
museum,
other,
]
eventType:
type: string
enum: [seated, general_admission]
venueName:
type: string
venueAddress:
type: string
description:
type: string
maxTickets:
type: integer
resaleEnabled:
type: boolean
contractAddress:
type: string
status:
type: string
imagePath:
type: string
required:
- eventId
- organizationId
- externalEventId
- name
- date
- eventType
- resaleEnabled
- status
"401":
description: Invalid or missing API key
"500":
description: Internal server error
post:
summary: Create a new event
description: Creates a new event for the authenticated organization
tags:
- Events
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
responses:
"201":
description: Event created successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
"400":
description: Invalid input parameters
"401":
description: Invalid or missing API key
"500":
description: Internal server error
/events/{eventId}:
get:
summary: Get event by ID
description: Retrieves a specific event by ID
tags:
- Events
security:
- ApiKeyAuth: []
parameters:
- in: path
name: eventId
required: true
schema:
type: string
responses:
"200":
description: Event retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
"401":
description: Invalid or missing API key
"404":
description: Event not found
"500":
description: Internal server error
/events/{eventId}/cancel:
post:
summary: Cancel an event
description: Cancels a specific event
tags:
- Events
security:
- ApiKeyAuth: []
parameters:
- in: path
name: eventId
required: true
schema:
type: string
responses:
"200":
description: Event cancelled successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
"401":
description: Invalid or missing API key
"404":
description: Event not found
"500":
description: Internal server error
/events/{eventId}/reactivate:
post:
summary: Reactivate an event
description: Reactivates a previously cancelled event
tags:
- Events
security:
- ApiKeyAuth: []
parameters:
- in: path
name: eventId
required: true
schema:
type: string
responses:
"200":
description: Event reactivated successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
"401":
description: Invalid or missing API key
"404":
description: Event not found
"500":
description: Internal server error
/tickets/create:
post:
summary: Create a new ticket
tags:
- Tickets
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Ticket"
responses:
"201":
description: Ticket created successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
ticketId:
type: string
"400":
description: Invalid input parameters
"401":
description: Invalid API key
"500":
description: Internal server error
/tickets/createBatch:
post:
summary: Create multiple tickets
tags:
- Tickets
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Tickets"
responses:
"201":
description: Tickets created successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
ticketIds:
type: array
items:
type: string
"400":
description: Invalid input parameters
"401":
description: Invalid API key
"500":
description: Internal server error
/tickets/burn:
post:
summary: Burn a ticket
tags:
- BurnTicket
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/BurnTicket"
responses:
"200":
description: Ticket burned successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
"404":
description: Ticket not found
"500":
description: Internal server error
/tickets/burnBatch:
post:
summary: Burn multiple tickets
tags:
- BurnTickets
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/BurnTickets"
responses:
"200":
description: Tickets burned successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
"404":
description: Ticket not found
"500":
description: Internal server error
/tickets/list:
post:
summary: List a ticket for sale
tags:
- Tickets
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TicketListing"
responses:
"200":
description: Ticket listed successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
"400":
description: Invalid input parameters
"401":
description: Invalid API key
"500":
description: Internal server error
/tickets/delist:
post:
summary: Remove ticket from sale
tags:
- Tickets
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TicketDelist"
responses:
"200":
description: Ticket delisted successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
"404":
description: No active listing found
"500":
description: Internal server error
/tickets/edit:
post:
summary: Edit ticket listing price
tags:
- Tickets
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TicketEdit"
responses:
"200":
description: Ticket price updated successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
listing:
type: object
"404":
description: No active listing found
"500":
description: Internal server error
/tickets/listings/{eventId}:
get:
summary: Get all listings for an event
tags:
- Tickets
security:
- ApiKeyAuth: []
parameters:
- in: path
name: eventId
required: true
schema:
type: string
responses:
"200":
description: Event listings retrieved successfully
content:
application/json:
schema:
type: object
properties:
event:
$ref: "#/components/schemas/Event"
listings:
type: array
items:
$ref: "#/components/schemas/TicketListing"
"404":
description: Event not found
"500":
description: Internal server error
/tickets/user/{userId}/tickets:
get:
summary: Get all tickets for a user
tags:
- Tickets
security:
- ApiKeyAuth: []
parameters:
- in: path
name: userId
required: true
schema:
type: string
responses:
"200":
description: User tickets retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Tickets"
"400":
description: Invalid user ID
"500":
description: Internal server error
/tickets/user/{userId}/tickets/event:
get:
summary: Get all tickets for a user with event information
tags:
- Tickets
security:
- ApiKeyAuth: []
parameters:
- in: path
name: userId
required: true
schema:
type: string
responses:
"200":
description: User tickets retrieved successfully
content:
application/json:
schema:
type: array
items:
type: object
properties:
ticket:
$ref: "#/components/schemas/Ticket"
event:
$ref: "#/components/schemas/Event"
"400":
description: Invalid user ID
"500":
description: Internal server error
/tickets/{ticketId}:
get:
summary: Get ticket by ID
tags:
- Tickets
security:
- ApiKeyAuth: []
parameters:
- in: path
name: ticketId
required: true
schema:
type: string
responses:
"200":
description: Ticket retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Ticket"
"404":
description: Ticket not found
"500":
description: Internal server error
/tickets/metadata/{ticketId}:
get:
summary: Get ticket metadata
tags:
- Tickets
security:
- ApiKeyAuth: []
parameters:
- in: path
name: ticketId
required: true
schema:
type: string
responses:
"200":
description: Ticket metadata retrieved successfully
content:
application/json:
schema:
type: object
properties:
name:
type: string
description:
type: string
image:
type: string
attributes:
type: array
items:
type: object
properties:
trait_type:
type: string
value:
type: string
"404":
description: Ticket not found
"500":
description: Internal server error
/tickets/status/{ticketId}:
get:
summary: Get ticket status
tags:
- Tickets
security:
- ApiKeyAuth: []
parameters:
- in: path
name: ticketId
required: true
schema:
type: string
responses:
"200":
description: Ticket status retrieved successfully
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum: [for_sale, not_for_sale, sold]
"404":
description: Ticket not found
"500":
description: Internal server error
/tickets/minted/{ticketId}:
get:
summary: Check if ticket is minted as NFT
tags:
- Tickets
security:
- ApiKeyAuth: []
parameters:
- in: path
name: ticketId
required: true
schema:
type: string
responses:
"200":
description: Minting status retrieved successfully
content:
application/json:
schema:
type: object
properties:
isMinted:
type: boolean
"500":
description: Internal server error
/tickets/user/{ticketId}:
get:
summary: Get ticket owner information
tags:
- Tickets
security:
- ApiKeyAuth: []
parameters:
- in: path
name: ticketId
required: true
schema:
type: string
responses:
"200":
description: Ticket owner information retrieved successfully
content:
application/json:
schema:
type: object
properties:
ownerId:
type: string
ownerEmail:
type: string
"404":
description: Ticket not found
"500":
description: Internal server error
/users/{userId}:
get:
summary: Get user information
description: Retrieves user information by user ID
tags:
- Users
security:
- ApiKeyAuth: []
parameters:
- in: path
name: userId
description: ID of the user to retrieve
required: true
schema:
type: string
responses:
"200":
description: User information retrieved successfully
content:
application/json:
schema:
type: object
properties:
userId:
type: string
name:
type: string
email:
type: string
# weitere Felder nach Bedarf
"404":
description: User not found
"500":
description: Internal server error
/oauth2/code:
post:
summary: Posts OAuth2 authorization code
description: Posts the authorization code for OAuth2 flow