· 6 years ago · Feb 12, 2020, 11:42 AM
1openapi: 3.0.0
2info:
3 title: Black Label API
4 description: Through this API you can build your own Live Cams site.
5 version: 1.2.0
6 contact:
7 email: webmaster@awempire.com
8servers:
9 - url: https://{whitelabelDomain}/{apiPrefix}/api/v1
10 description: "The partner's own whitelabel site on AWEmpire.com. The whitelabel-domain is the domain where the Partner's Whitelabel site is running."
11 variables:
12 whitelabelDomain:
13 default: www.example.com
14 apiPrefix:
15 default: en
16tags:
17 - name: Guest
18 description: These endpoints do not need the user to be logged into a Whitelabel system.
19 - name: Member
20 description: These endpoints need the user to be logged into the Whitelabel system.
21paths:
22 /auto-suggest:
23 get:
24 tags:
25 - Guest
26 - Member
27 summary: Suggests performers and filters based on the given search text and category.
28 parameters:
29 - $ref: "#/components/parameters/secret"
30 - $ref: "#/components/parameters/clientIp"
31 - $ref: "#/components/parameters/userAgent"
32 - $ref: "#/components/parameters/sessionId"
33 - $ref: "#/components/parameters/category"
34 - $ref: "#/components/parameters/searchText"
35 responses:
36 200:
37 headers:
38 X-Session-Id:
39 $ref: "#/components/headers/X-Session-Id"
40 X-Api-Prefix:
41 $ref: "#/components/headers/X-Api-Prefix"
42 description: Successful operation
43 content:
44 application/json:
45 schema:
46 $ref: "#/components/schemas/AutoSuggestResponse"
47 400:
48 $ref: "#/components/responses/400"
49 401:
50 $ref: "#/components/responses/401"
51 500:
52 $ref: "#/components/responses/500"
53
54 /filters:
55 get:
56 tags:
57 - Guest
58 - Member
59 summary: Returns the list of categories and their filters.
60 parameters:
61 - $ref: "#/components/parameters/secret"
62 - $ref: "#/components/parameters/clientIp"
63 - $ref: "#/components/parameters/userAgent"
64 - $ref: "#/components/parameters/sessionId"
65 - $ref: "#/components/parameters/useApiTranslation"
66 responses:
67 200:
68 headers:
69 X-Session-Id:
70 $ref: "#/components/headers/X-Session-Id"
71 X-Api-Prefix:
72 $ref: "#/components/headers/X-Api-Prefix"
73 description: Successful operation
74 content:
75 application/json:
76 schema:
77 $ref: "#/components/schemas/FilterResponse"
78 401:
79 $ref: "#/components/responses/401"
80 500:
81 $ref: "#/components/responses/500"
82
83 /keep-alive:
84 get:
85 tags:
86 - Guest
87 - Member
88 summary: Keeps the initialized session alive.
89 parameters:
90 - $ref: "#/components/parameters/secret"
91 - $ref: "#/components/parameters/clientIp"
92 - $ref: "#/components/parameters/userAgent"
93 - $ref: "#/components/parameters/sessionIdRequired"
94 responses:
95 200:
96 headers:
97 X-Session-Id:
98 $ref: "#/components/headers/X-Session-Id"
99 X-Api-Prefix:
100 $ref: "#/components/headers/X-Api-Prefix"
101 description: Successful operation
102 401:
103 $ref: "#/components/responses/401"
104 500:
105 $ref: "#/components/responses/500"
106
107 /languages:
108 get:
109 tags:
110 - Guest
111 - Member
112 summary: Returns the available languages.
113 parameters:
114 - $ref: "#/components/parameters/secret"
115 - $ref: "#/components/parameters/clientIp"
116 - $ref: "#/components/parameters/userAgent"
117 - $ref: "#/components/parameters/sessionId"
118 responses:
119 200:
120 headers:
121 X-Session-Id:
122 $ref: "#/components/headers/X-Session-Id"
123 X-Api-Prefix:
124 $ref: "#/components/headers/X-Api-Prefix"
125 description: Successful operation
126 content:
127 application/json:
128 schema:
129 $ref: "#/components/schemas/LanguagesResponse"
130 500:
131 $ref: "#/components/responses/500"
132
133 /performers:
134 get:
135 tags:
136 - Guest
137 - Member
138 summary: Returns a list of performers.
139 parameters:
140 - $ref: "#/components/parameters/secret"
141 - $ref: "#/components/parameters/clientIp"
142 - $ref: "#/components/parameters/userAgent"
143 - $ref: "#/components/parameters/sessionId"
144 - $ref: "#/components/parameters/category"
145 - $ref: "#/components/parameters/useApiTranslation"
146 - $ref: "#/components/parameters/pageSize"
147 - $ref: "#/components/parameters/searchTextNotRequired"
148 responses:
149 200:
150 headers:
151 X-Session-Id:
152 $ref: "#/components/headers/X-Session-Id"
153 X-Api-Prefix:
154 $ref: "#/components/headers/X-Api-Prefix"
155 description: Successful operation
156 content:
157 application/json:
158 schema:
159 $ref: "#/components/schemas/PerformersResponse"
160 400:
161 $ref: "#/components/responses/400"
162 401:
163 $ref: "#/components/responses/401"
164 500:
165 $ref: "#/components/responses/500"
166
167 /performers/{performerNick}:
168 get:
169 tags:
170 - Guest
171 - Member
172 summary: Returns the details of a performer.
173 parameters:
174 - $ref: "#/components/parameters/secret"
175 - $ref: "#/components/parameters/clientIp"
176 - $ref: "#/components/parameters/userAgent"
177 - $ref: "#/components/parameters/sessionId"
178 - $ref: "#/components/parameters/performerNickPath"
179 - $ref: "#/components/parameters/useApiTranslation"
180 responses:
181 200:
182 headers:
183 X-Session-Id:
184 $ref: "#/components/headers/X-Session-Id"
185 X-Api-Prefix:
186 $ref: "#/components/headers/X-Api-Prefix"
187 description: Successful operation
188 content:
189 application/json:
190 schema:
191 $ref: "#/components/schemas/PerformerDetailsResponse"
192 400:
193 $ref: "#/components/responses/400"
194 401:
195 $ref: "#/components/responses/401"
196 404:
197 $ref: "#/components/responses/404"
198 500:
199 $ref: "#/components/responses/500"
200
201 /performers/{performerNick}/albums:
202 get:
203 tags:
204 - Guest
205 - Member
206 summary: Returns the albums of the performer.
207 parameters:
208 - $ref: "#/components/parameters/secret"
209 - $ref: "#/components/parameters/clientIp"
210 - $ref: "#/components/parameters/userAgent"
211 - $ref: "#/components/parameters/sessionId"
212 - $ref: "#/components/parameters/performerNickPath"
213 - $ref: "#/components/parameters/privacyFilter"
214 - $ref: "#/components/parameters/typeFilter"
215 responses:
216 200:
217 headers:
218 X-Session-Id:
219 $ref: "#/components/headers/X-Session-Id"
220 X-Api-Prefix:
221 $ref: "#/components/headers/X-Api-Prefix"
222 description: Successful operation
223 content:
224 application/json:
225 schema:
226 $ref: "#/components/schemas/AlbumResponse"
227 400:
228 $ref: "#/components/responses/400"
229 401:
230 $ref: "#/components/responses/401"
231 404:
232 $ref: "#/components/responses/404"
233 500:
234 $ref: "#/components/responses/500"
235
236 /performers/{performerNick}/albums/{albumId}/items:
237 get:
238 tags:
239 - Guest
240 - Member
241 summary: Returns the item list for the given album.
242 parameters:
243 - $ref: "#/components/parameters/secret"
244 - $ref: "#/components/parameters/clientIp"
245 - $ref: "#/components/parameters/userAgent"
246 - $ref: "#/components/parameters/sessionId"
247 - $ref: "#/components/parameters/performerNickPath"
248 - $ref: "#/components/parameters/albumId"
249 responses:
250 200:
251 headers:
252 X-Session-Id:
253 $ref: "#/components/headers/X-Session-Id"
254 X-Api-Prefix:
255 $ref: "#/components/headers/X-Api-Prefix"
256 description: Successful operation
257 content:
258 application/json:
259 schema:
260 $ref: "#/components/schemas/AlbumItemsResponse"
261 400:
262 $ref: "#/components/responses/400"
263 401:
264 $ref: "#/components/responses/401"
265 404:
266 $ref: "#/components/responses/404"
267 500:
268 $ref: "#/components/responses/500"
269
270 /performers/{performerNick}/videos:
271 get:
272 tags:
273 - Guest
274 - Member
275 summary: Returns the video list of the performer.
276 parameters:
277 - $ref: "#/components/parameters/secret"
278 - $ref: "#/components/parameters/clientIp"
279 - $ref: "#/components/parameters/userAgent"
280 - $ref: "#/components/parameters/sessionId"
281 - $ref: "#/components/parameters/performerNickPath"
282 - $ref: "#/components/parameters/privacyFilter"
283 responses:
284 200:
285 headers:
286 X-Session-Id:
287 $ref: "#/components/headers/X-Session-Id"
288 X-Api-Prefix:
289 $ref: "#/components/headers/X-Api-Prefix"
290 description: Successful operation
291 content:
292 application/json:
293 schema:
294 $ref: "#/components/schemas/VideosResponse"
295 400:
296 $ref: "#/components/responses/400"
297 401:
298 $ref: "#/components/responses/401"
299 404:
300 $ref: "#/components/responses/404"
301 500:
302 $ref: "#/components/responses/500"
303
304 /performers/{performerNick}/videos/{videoId}:
305 get:
306 tags:
307 - Guest
308 - Member
309 summary: Returns a video of a performer.
310 parameters:
311 - $ref: "#/components/parameters/secret"
312 - $ref: "#/components/parameters/clientIp"
313 - $ref: "#/components/parameters/userAgent"
314 - $ref: "#/components/parameters/sessionId"
315 - $ref: "#/components/parameters/performerNickPath"
316 - $ref: '#/components/parameters/videoIdPath'
317 responses:
318 200:
319 headers:
320 X-Session-Id:
321 $ref: "#/components/headers/X-Session-Id"
322 X-Api-Prefix:
323 $ref: "#/components/headers/X-Api-Prefix"
324 description: Successful operation
325 content:
326 application/json:
327 schema:
328 $ref: "#/components/schemas/VideoItemResponse"
329 400:
330 $ref: "#/components/responses/400"
331 401:
332 $ref: "#/components/responses/401"
333 404:
334 $ref: "#/components/responses/404"
335 500:
336 $ref: "#/components/responses/500"
337
338 /purchases/album:
339 post:
340 tags:
341 - Member
342 summary: Purchases the chosen album.
343 parameters:
344 - $ref: "#/components/parameters/secret"
345 - $ref: "#/components/parameters/clientIp"
346 - $ref: "#/components/parameters/userAgent"
347 - $ref: "#/components/parameters/sessionId"
348 requestBody:
349 $ref: '#/components/requestBodies/PurchaseAlbum'
350 responses:
351 201:
352 headers:
353 X-Session-Id:
354 $ref: "#/components/headers/X-Session-Id"
355 X-Api-Prefix:
356 $ref: "#/components/headers/X-Api-Prefix"
357 Location:
358 $ref: "#/components/headers/PurchasedItemLocation"
359 description: Successful operation
360 303:
361 $ref: "#/components/responses/303"
362 400:
363 $ref: "#/components/responses/400"
364 401:
365 $ref: "#/components/responses/401"
366 402:
367 $ref: "#/components/responses/402"
368 403:
369 $ref: "#/components/responses/403"
370 404:
371 $ref: "#/components/responses/404"
372 500:
373 $ref: "#/components/responses/500"
374
375 /purchases/video:
376 post:
377 tags:
378 - Member
379 summary: Purchases the chosen video.
380 parameters:
381 - $ref: "#/components/parameters/secret"
382 - $ref: "#/components/parameters/clientIp"
383 - $ref: "#/components/parameters/userAgent"
384 - $ref: "#/components/parameters/sessionId"
385 requestBody:
386 $ref: '#/components/requestBodies/PurchaseVideo'
387 responses:
388 201:
389 headers:
390 X-Session-Id:
391 $ref: "#/components/headers/X-Session-Id"
392 X-Api-Prefix:
393 $ref: "#/components/headers/X-Api-Prefix"
394 Location:
395 $ref: "#/components/headers/PurchasedItemLocation"
396 description: Successful operation
397 303:
398 $ref: "#/components/responses/303"
399 400:
400 $ref: "#/components/responses/400"
401 401:
402 $ref: "#/components/responses/401"
403 403:
404 $ref: "#/components/responses/403"
405 404:
406 $ref: "#/components/responses/404"
407 402:
408 $ref: "#/components/responses/402"
409 500:
410 $ref: "#/components/responses/500"
411
412 /recommendations:
413 get:
414 tags:
415 - Guest
416 - Member
417 summary: Returns the recommended performers.
418 parameters:
419 - $ref: "#/components/parameters/secret"
420 - $ref: "#/components/parameters/clientIp"
421 - $ref: "#/components/parameters/userAgent"
422 - $ref: "#/components/parameters/sessionId"
423 - $ref: "#/components/parameters/useApiTranslation"
424 - $ref: "#/components/parameters/category"
425 - $ref: "#/components/parameters/currentPerformerNick"
426 - $ref: "#/components/parameters/itemCount"
427 responses:
428 200:
429 headers:
430 X-Session-Id:
431 $ref: "#/components/headers/X-Session-Id"
432 X-Api-Prefix:
433 $ref: "#/components/headers/X-Api-Prefix"
434 description: Successful operation
435 content:
436 application/json:
437 schema:
438 $ref: "#/components/schemas/RecommendationResponse"
439 400:
440 $ref: "#/components/responses/400"
441 401:
442 $ref: "#/components/responses/401"
443 500:
444 $ref: "#/components/responses/500"
445
446 /scripts/chat:
447 get:
448 tags:
449 - Guest
450 - Member
451 summary: Returns the javascript code for the chat player.
452 parameters:
453 - $ref: "#/components/parameters/secret"
454 - $ref: "#/components/parameters/clientIp"
455 - $ref: "#/components/parameters/userAgent"
456 - $ref: "#/components/parameters/sessionId"
457 - $ref: "#/components/parameters/performerNickQuery"
458 - $ref: "#/components/parameters/containerId"
459 - $ref: "#/components/parameters/primaryButtonBg"
460 - $ref: "#/components/parameters/primaryButtonColor"
461 - $ref: "#/components/parameters/inputBg"
462 - $ref: "#/components/parameters/inputColor"
463 responses:
464 200:
465 headers:
466 X-Session-Id:
467 $ref: "#/components/headers/X-Session-Id"
468 X-Api-Prefix:
469 $ref: "#/components/headers/X-Api-Prefix"
470 description: Successful operation
471 content:
472 text/javascript:
473 schema:
474 $ref: "#/components/schemas/ScriptResponse"
475 400:
476 $ref: "#/components/responses/400"
477 401:
478 $ref: "#/components/responses/401"
479 500:
480 $ref: "#/components/responses/500"
481
482 /show-more:
483 get:
484 tags:
485 - Guest
486 - Member
487 summary: Returns the next page of the listpage.
488 parameters:
489 - $ref: "#/components/parameters/secret"
490 - $ref: "#/components/parameters/clientIp"
491 - $ref: "#/components/parameters/userAgent"
492 - $ref: "#/components/parameters/sessionId"
493 - $ref: "#/components/parameters/listPageId"
494 responses:
495 200:
496 headers:
497 X-Session-Id:
498 $ref: "#/components/headers/X-Session-Id"
499 X-Api-Prefix:
500 $ref: "#/components/headers/X-Api-Prefix"
501 description: Successful operation
502 content:
503 application/json:
504 schema:
505 $ref: "#/components/schemas/ShowMoreResponse"
506 400:
507 $ref: "#/components/responses/400"
508 401:
509 $ref: "#/components/responses/401"
510 500:
511 $ref: "#/components/responses/500"
512
513 /users:
514 post:
515 tags:
516 - Guest
517 summary: Connects the partner's user to the live cams application.
518 requestBody:
519 $ref: "#/components/requestBodies/UserPost"
520 parameters:
521 - $ref: "#/components/parameters/secret"
522 - $ref: "#/components/parameters/clientIp"
523 - $ref: "#/components/parameters/userAgent"
524 - $ref: "#/components/parameters/sessionId"
525 responses:
526 200:
527 headers:
528 X-Session-Id:
529 $ref: "#/components/headers/X-Session-Id"
530 X-Api-Prefix:
531 $ref: "#/components/headers/X-Api-Prefix"
532 description: Successful operation
533 content:
534 application/json:
535 schema:
536 $ref: "#/components/schemas/UsersResponse"
537 400:
538 $ref: "#/components/responses/400"
539 401:
540 $ref: "#/components/responses/401"
541 500:
542 $ref: "#/components/responses/500"
543
544 /users/{partnerUserId}:
545 patch:
546 tags:
547 - Member
548 summary: Modifies the data of the user.
549 requestBody:
550 $ref: "#/components/requestBodies/UserPatch"
551 parameters:
552 - $ref: "#/components/parameters/secret"
553 - $ref: "#/components/parameters/clientIp"
554 - $ref: "#/components/parameters/userAgent"
555 - $ref: "#/components/parameters/sessionIdRequired"
556 - $ref: "#/components/parameters/partnerUserId"
557 responses:
558 200:
559 headers:
560 X-Session-Id:
561 $ref: "#/components/headers/X-Session-Id"
562 X-Api-Prefix:
563 $ref: "#/components/headers/X-Api-Prefix"
564 description: Successful operation
565 content:
566 application/json:
567 schema:
568 $ref: "#/components/schemas/UsersPatchResponse"
569 400:
570 $ref: "#/components/responses/400"
571 401:
572 $ref: "#/components/responses/401"
573 404:
574 $ref: "#/components/responses/404"
575 500:
576 $ref: "#/components/responses/500"
577
578components:
579 requestBodies:
580 PurchaseAlbum:
581 description: |
582 |name|type|description|
583 |:-|:-|:-|
584 |**id**|string|The ID of the album.|
585 |**performerNick**|string|The nick of the performer.|
586 required: true
587 content:
588 application/json:
589 schema:
590 $ref: "#/components/schemas/PurchaseAlbum"
591 PurchaseVideo:
592 description: |
593 |name|type|description|
594 |:-|:-|:-|
595 |**id**|string|The ID of the video.|
596 |**performerNick**|string|The nick of the performer.|
597 required: true
598 content:
599 application/json:
600 schema:
601 $ref: "#/components/schemas/PurchaseVideo"
602 UserPatch:
603 description: |
604 |name|type|description|
605 |:-|:-|:-|
606 |**partnerUserId**|string|The unique ID of the user in the Partner's system. Min: 1 Max: 128 characters.|
607 |**displayName**|string|The username of the user in the Partner's system, this name will appear for others in the API. Min: 4 Max: 30 characters.|
608 |**email**|string|The email of the user in the Partner's system.|
609 required: true
610 content:
611 application/json:
612 schema:
613 $ref: "#/components/schemas/User"
614 UserPost:
615 description: |
616 |name|type|description|
617 |:-|:-|:-|
618 |**partnerUserId**|string|The unique ID of the user in the Partner's system. Min: 1 Max: 128 characters.|
619 |**displayName**|string|The username of the user in the Partner's system, this name will appear for others in the API. Min: 4 Max: 30 characters.|
620 |**email**|string|The email of the user in the Partner's system.|
621 required: true
622 content:
623 application/json:
624 schema:
625 $ref: "#/components/schemas/User"
626 responses:
627 303:
628 description: Redirect to the already purchased resource.
629 400:
630 description: The request contains invalid parameters or data.
631 content:
632 application/json:
633 schema:
634 type: object
635 properties:
636 errors:
637 type: array
638 items:
639 $ref: "#/components/schemas/Error"
640 401:
641 description: Not authenticated.
642 402:
643 description: Payment required.
644 403:
645 description: Forbidden.
646 404:
647 description: The reource is not found.
648 500:
649 description: Internal server error.
650 headers:
651 X-Session-Id:
652 schema:
653 type: string
654 description: The session ID from the Black Label API.
655 X-Api-Prefix:
656 schema:
657 type: string
658 description: The API prefix that should be used during the request.
659 PurchasedItemLocation:
660 schema:
661 type: string
662 description: Location to retrieve the purchased item.
663 parameters:
664 albumId:
665 name: albumId
666 in: path
667 description: The ID of the image albums.
668 required: true
669 schema:
670 type: string
671 example: 5da877b870522a6003af0d0a
672 category:
673 name: category
674 in: query
675 description: The category of the performer.
676 required: true
677 schema:
678 type: string
679 example: girls
680 clientIp:
681 name: X-Client-Ip
682 in: header
683 description: The IP of the client of the user who is browsing on the webpage.
684 required: true
685 schema:
686 type: string
687 format: ipv4
688 containerId:
689 name: containerId
690 in: query
691 required: true
692 schema:
693 type: string
694 pattern: '^[a-zA-Z0-9#_\.]+$'
695 example: chatDivId
696 currentPerformerNick:
697 name: currentPerformerNick
698 in: query
699 description: The performer who wont be in the list.
700 required: false
701 schema:
702 type: string
703 example: JaneHosk
704 inputBg:
705 name: inputBg
706 in: query
707 required: false
708 schema:
709 type: string
710 pattern: "^[0-9a-fA-F]+$"
711 example: "000000"
712 inputColor:
713 name: inputColor
714 in: query
715 required: false
716 schema:
717 type: string
718 pattern: "^[0-9a-fA-F]+$"
719 example: ffffff
720 itemCount:
721 name: itemCount
722 in: query
723 description: How many performers will be listed.
724 required: false
725 schema:
726 type: integer
727 minimum: 4
728 maximum: 10
729 default: 4
730 listPageId:
731 name: listPageId
732 in: query
733 description: The id of the listpage which was returned in the GET /performers or used in the previous /show-more call.
734 required: true
735 schema:
736 type: string
737 pageSize:
738 name: pageSize
739 in: query
740 description: How many performers will be listed.
741 required: false
742 schema:
743 type: integer
744 minimum: 4
745 maximum: 100
746 default: 20
747 partnerUserId:
748 name: partnerUserId
749 in: path
750 description: The ID of the partner's user.
751 required: true
752 schema:
753 type: string
754 minLength: 1
755 maxLength: 128
756 performerNickPath:
757 name: performerNick
758 in: path
759 description: The nick of the performer.
760 required: true
761 schema:
762 type: string
763 example: JaneHosk
764 performerNickQuery:
765 name: performerNick
766 in: query
767 description: The nick of the performer.
768 required: true
769 schema:
770 type: string
771 example: Jane Doe
772 primaryButtonBg:
773 name: primaryButtonBg
774 in: query
775 required: false
776 schema:
777 type: string
778 pattern: "^[0-9a-fA-F]+$"
779 example: FFFFFF
780 primaryButtonColor:
781 name: primaryButtonColor
782 in: query
783 required: false
784 schema:
785 type: string
786 pattern: "^[0-9a-fA-F]+$"
787 example: "000000"
788 privacyFilter:
789 name: privacy
790 in: query
791 description: The privacy of the content. Can be public, exclusive or all (default).
792 required: false
793 schema:
794 type: string
795 example: all
796 searchText:
797 name: searchText
798 in: query
799 description: The search text what we are searching for.
800 required: true
801 schema:
802 type: string
803 example: Jane
804 searchTextNotRequired:
805 name: searchText
806 in: query
807 description: The search text what we are searching for.
808 required: false
809 schema:
810 type: string
811 example: Jane
812 secret:
813 name: X-Application-Secret
814 in: header
815 description: The secret hash to authenticate the call.
816 required: true
817 schema:
818 type: string
819 sessionId:
820 name: X-Session-Id
821 in: header
822 description: The session from the Black Label API.
823 required: false
824 schema:
825 type: string
826 sessionIdRequired:
827 name: X-Session-Id
828 in: header
829 description: The session from the Black Label API.
830 required: true
831 schema:
832 type: string
833 typeFilter:
834 name: type
835 in: query
836 description: The type of the album. Can be image, video, all (default).
837 required: false
838 schema:
839 type: string
840 example: all
841 userAgent:
842 name: X-User-Agent
843 in: header
844 description: The user agent of the browser.
845 required: true
846 schema:
847 type: string
848 useApiTranslation:
849 name: useApiTranslation
850 in: query
851 description: If set to 1 it will translate some data of the requested resource to the language which provided in the api-prefix.
852 required: false
853 schema:
854 type: string
855 enum: [0, 1]
856 default: 1
857 videoIdPath:
858 name: videoId
859 in: path
860 description: The ID of the video.
861 required: true
862 schema:
863 type: string
864 example: 5da877b870522a6003af0d0d
865 schemas:
866 Album:
867 type: object
868 properties:
869 id:
870 type: string
871 example: 5acb478c70522a872e0457da
872 title:
873 type: string
874 example: My album
875 coverImageUrls:
876 type: array
877 items:
878 type: object
879 title: resolution key
880 additionalProperties:
881 $ref: "#/components/schemas/UrlItem"
882 example:
883 400:
884 url: http://example.com/image1.jpg
885 width: 400
886 height: 300
887 1280:
888 url: http://example.com/image2.jpg
889 width: 1280
890 height: 720
891 type:
892 type: string
893 example: image
894 contentCount:
895 type: integer
896 example: 5
897 privacy:
898 type: string
899 example: exclusive
900 price:
901 type: number
902 isLocked:
903 type: boolean
904 AlbumItemsResponse:
905 type: object
906 properties:
907 data:
908 type: object
909 properties:
910 items:
911 type: array
912 items:
913 $ref: "#/components/schemas/ImageItem"
914 AlbumResponse:
915 type: object
916 properties:
917 data:
918 type: object
919 properties:
920 albums:
921 type: array
922 items:
923 $ref: "#/components/schemas/Album"
924 AutoSuggestResponse:
925 type: object
926 properties:
927 data:
928 type: object
929 properties:
930 performers:
931 type: array
932 items:
933 $ref: "#/components/schemas/AutoSuggestPerformer"
934 tags:
935 type: array
936 items:
937 $ref: "#/components/schemas/AutoSuggestTag"
938 AutoSuggestPerformer:
939 type: object
940 properties:
941 nick:
942 type: string
943 example: Jane
944 imageSrc:
945 type: string
946 example: https://img0.dditscdn.com/ff268cab8d9fbae1ed7506f97496274f19/9fabf365b7c50f143f9bb2ced7ac6852_glamour_224x168.jpg?cno=191144
947 status:
948 type: integer
949 enum: [0, 1, 2]
950 example: 1
951 description: 0=offline, 1=in free, 2=in private
952 category:
953 type: string
954 example: girls
955 AutoSuggestTag:
956 type: object
957 properties:
958 name:
959 type: string
960 example: girl
961 ChatScriptUrl:
962 type: string
963 example: A template url for the chat javascript to embed.
964 Error:
965 type: object
966 properties:
967 message:
968 type: string
969 code:
970 type: integer
971 FilterResponse:
972 type: object
973 properties:
974 data:
975 type: object
976 properties:
977 categories:
978 $ref: "#/components/schemas/FilterCategories"
979
980 FilterCategories:
981 type: array
982 items:
983 type: object
984 title: resolution key
985 example:
986 girls:
987 - girl
988 - amateur
989 - lesbian
990 boys:
991 - boy
992 - gay
993 - amateur
994 ImageItem:
995 type: object
996 properties:
997 id:
998 type: string
999 coverImageUrls:
1000 type: array
1001 items:
1002 type: object
1003 additionalProperties:
1004 $ref: "#/components/schemas/UrlItem"
1005 example:
1006 400:
1007 url: http://example.com/image1.jpg
1008 width: 400
1009 height: 300
1010 1280:
1011 url: http://example.com/image2.jpg
1012 width: 1280
1013 height: 720
1014 1600:
1015 url: http://example.com/image3.jpg
1016 width: 1600
1017 height: 1200
1018 1920:
1019 url: http://example.com/image4.jpg
1020 width: 1920
1021 height: 1080
1022 urls:
1023 type: array
1024 items:
1025 type: object
1026 additionalProperties:
1027 $ref: "#/components/schemas/UrlItem"
1028 example:
1029 400:
1030 url: http://example.com/image1.jpg
1031 width: 400
1032 height: 300
1033 1280:
1034 url: http://example.com/image2.jpg
1035 width: 1280
1036 height: 720
1037 1600:
1038 url: http://example.com/image3.jpg
1039 width: 1600
1040 height: 1200
1041 1920:
1042 url: http://example.com/image4.jpg
1043 width: 1920
1044 height: 1080
1045 type:
1046 type: string
1047 example: image
1048 Languages:
1049 type: object
1050 properties:
1051 languages:
1052 type: array
1053 items:
1054 properties:
1055 code:
1056 type: string
1057 example: de
1058 enName:
1059 type: string
1060 example: German
1061 selfName:
1062 type: string
1063 example: Deutsch
1064 LanguagesResponse:
1065 type: object
1066 properties:
1067 data:
1068 $ref: "#/components/schemas/Languages"
1069 LiveFeedPlayerUrl:
1070 type: string
1071 example: A template url for the live feed player to be used on an iframe tag.
1072 ListPageId:
1073 type: string
1074 example: 1123331231231333123
1075 Performer:
1076 type: object
1077 properties:
1078 id:
1079 type: integer
1080 example: 12345
1081 nick:
1082 type: string
1083 example: performerName
1084 status:
1085 type: integer
1086 enum: [0, 1, 2]
1087 example: 1
1088 description: 0=offline, 1=in free, 2=in private
1089 category:
1090 type: string
1091 example: girls
1092 mainCategory:
1093 type: string
1094 example: hot_flirts
1095 price:
1096 type: number
1097 format: float
1098 example: 1.99
1099 description: The credits per minute for private.
1100 personAge:
1101 type: string
1102 example: 22,23
1103 description: Comma separated list of person's ages.
1104 language:
1105 type: string
1106 description: Comma separated list of available languages the performer speaks.
1107 example: en,pt
1108 region:
1109 type: string
1110 enum: [NA, SA, EU, AS, AF]
1111 example: EU
1112 description: NA=north america, SA=south america, EU=europe, AS=australia, AF=africa
1113 averageRating:
1114 type: number
1115 format: float
1116 minimum: 0
1117 maximum: 5
1118 example: 3.12
1119 description: The avarage rating of the performer.
1120 ethnicity:
1121 type: string
1122 description: Comma separated list of person's ethnicities.
1123 example: latin,asian
1124 willingness:
1125 type: string
1126 description: Comma separated list of available willingness.
1127 example: snapshot,oral,dancing
1128 hasStory:
1129 type: boolean
1130 description: Does the performer have story available?
1131 isVideoCallEnabled:
1132 type: boolean
1133 description: Does the performer have video call enabled?
1134 isVibratorActive:
1135 type: boolean
1136 description: Does the performer have the vibratoy feature enabled?
1137 hasVipShow:
1138 type: boolean
1139 description: Does the performer have VIP show?
1140 profilePictures:
1141 $ref: "#/components/schemas/ProfilePictures"
1142 PerformerData:
1143 type: object
1144 properties:
1145 performers:
1146 type: array
1147 items:
1148 $ref: "#/components/schemas/Performer"
1149 listPageId:
1150 $ref: "#/components/schemas/ListPageId"
1151 chatScripUrl:
1152 $ref: "#/components/schemas/ChatScriptUrl"
1153 liveFeedPlayerUrl:
1154 $ref: "#/components/schemas/LiveFeedPlayerUrl"
1155 isLastPage:
1156 type: boolean
1157 PerformerDetails:
1158 type: object
1159 allOf:
1160 - $ref: "#/components/schemas/Performer"
1161 - $ref: "#/components/schemas/PerformerExtra"
1162 PerformerDetailsResponse:
1163 type: object
1164 properties:
1165 data:
1166 $ref: "#/components/schemas/PerformerDetails"
1167 PerformerExtra:
1168 type: object
1169 properties:
1170 chatScriptUrl:
1171 $ref: "#/components/schemas/ChatScriptUrl"
1172 bio:
1173 type: string
1174 example: bio text
1175 description: The bio information written by the performer.
1176 turnsOn:
1177 type: string
1178 description: The turns me on section written by the performer.
1179 turnsOff:
1180 type: string
1181 description: The turns me off section written by the performer.
1182 appearance:
1183 type: string
1184 description: Comma separated list of appearance available.
1185 specialLocation:
1186 type: string
1187 description: Comma separated list of special locations available.
1188 sexualPreferences:
1189 type: string
1190 description: Comma separated list of sexual preferences available.
1191 persons:
1192 type: array
1193 items:
1194 $ref: "#/components/schemas/Person"
1195 PerformersResponse:
1196 type: object
1197 properties:
1198 data:
1199 $ref: "#/components/schemas/PerformerData"
1200 Person:
1201 type: object
1202 properties:
1203 gender:
1204 type: string
1205 age:
1206 type: integer
1207 hairColor:
1208 type: string
1209 hairLength:
1210 type: string
1211 eyeColor:
1212 type: string
1213 build:
1214 type: string
1215 breastSize:
1216 type: string
1217 penisSize:
1218 type: string
1219 ProfilePictures:
1220 type: object
1221 properties:
1222 285x160:
1223 type: string
1224 358x201:
1225 type: string
1226 445x250:
1227 type: string
1228 224x168:
1229 type: string
1230 460x345:
1231 type: string
1232 1024x768:
1233 type: string
1234 PurchaseAlbum:
1235 type: object
1236 properties:
1237 id:
1238 type: string
1239 example: 5da877b870522a6003af0d0b
1240 description: The id of the image album to purchase.
1241 performerNick:
1242 type: string
1243 example: JaneHosk
1244 description: The nick of the performer.
1245 PurchaseVideo:
1246 type: object
1247 properties:
1248 id:
1249 type: string
1250 example: 5da877b870522a6003af0d0c
1251 description: The id of the video to purchase.
1252 performerNick:
1253 type: string
1254 example: JaneHosk
1255 description: The nick of the performer.
1256 RecommendationResponse:
1257 type: object
1258 properties:
1259 data:
1260 type: object
1261 properties:
1262 performers:
1263 type: array
1264 items:
1265 $ref: "#/components/schemas/RecommendedPerformer"
1266 chatScripUrl:
1267 $ref: "#/components/schemas/ChatScriptUrl"
1268 liveFeedPlayerUrl:
1269 $ref: "#/components/schemas/LiveFeedPlayerUrl"
1270 RecommendedPerformer:
1271 type: object
1272 properties:
1273 id:
1274 type: integer
1275 example: 12345
1276 nick:
1277 type: string
1278 example: performerName
1279 status:
1280 type: integer
1281 enum: [0, 1, 2]
1282 example: 1
1283 description: 0=offline, 1=in free, 2=in private
1284 category:
1285 type: string
1286 mainCategory:
1287 type: string
1288 price:
1289 type: number
1290 format: float
1291 example: 1.99
1292 description: The credits per minute for private.
1293 language:
1294 type: string
1295 description: Comma separated list of available languages the performer speaks.
1296 example: en,pt
1297 averageRating:
1298 type: number
1299 format: float
1300 minimum: 0
1301 maximum: 5
1302 example: 3.12
1303 description: The avarage rating of the performer.
1304 willingness:
1305 type: string
1306 description: Comma separated list of available willingness.
1307 example: snapshot,oral,dancing
1308 profilePictures:
1309 $ref: "#/components/schemas/ProfilePictures"
1310 ScriptResponse:
1311 type: string
1312 example: Javascript code
1313 ShowMoreResponse:
1314 type: object
1315 properties:
1316 data:
1317 $ref: "#/components/schemas/PerformerData"
1318 UrlItem:
1319 type: object
1320 properties:
1321 url:
1322 type: string
1323 example: URL for the image
1324 width:
1325 type: integer
1326 example: 400
1327 height:
1328 type: integer
1329 example: 300
1330 User:
1331 type: object
1332 properties:
1333 partnerUserId:
1334 type: string
1335 example: "345561"
1336 description: The unique id of the user in the system of the Partner.
1337 displayName:
1338 type: string
1339 example: Jimmy
1340 description: The username or displaynem of the user in the Partner's system what the other user can see.
1341 email:
1342 type: string
1343 example: jimmy@example.email
1344 description: The email of the user.
1345 UserResult:
1346 type: object
1347 properties:
1348 userType:
1349 type: string
1350 example: guest
1351 description: The type of the member in the Blacklabel system, could be guest or member.
1352 purchaseUrl:
1353 type: string
1354 example: https://domain/en/member/auth/credit
1355 description: The purchase url, where the user can buy credits to spend on the Blacklabel features.
1356 registeredDisplayName:
1357 type: string
1358 example: Jimmy
1359 description: The final display name that the system allocated after it cleared the original one.
1360 registeredUserIdentifier:
1361 type: string
1362 example: Jimmy_sef
1363 description: The registered user identifier that the system allocated.
1364 UsersPatchResponse:
1365 type: object
1366 properties:
1367 data:
1368 $ref: "#/components/schemas/UserResult"
1369 UsersResponse:
1370 type: object
1371 properties:
1372 data:
1373 $ref: "#/components/schemas/UserResult"
1374 VideosResponse:
1375 type: object
1376 properties:
1377 data:
1378 type: object
1379 properties:
1380 items:
1381 type: array
1382 items:
1383 $ref: "#/components/schemas/VideoItem"
1384 VideoItem:
1385 type: object
1386 properties:
1387 id:
1388 type: string
1389 title:
1390 type: string
1391 coverImageUrls:
1392 type: array
1393 items:
1394 type: object
1395 additionalProperties:
1396 $ref: "#/components/schemas/UrlItem"
1397 example:
1398 400:
1399 url: http://example.com/image1.jpg
1400 width: 400
1401 height: 300
1402 1280:
1403 url: http://example.com/image2.jpg
1404 width: 1280
1405 height: 720
1406 urls:
1407 type: array
1408 items:
1409 type: object
1410 additionalProperties:
1411 $ref: "#/components/schemas/UrlItem"
1412 example:
1413 448:
1414 896:
1415 url: http://example.com/video2.mp4
1416 width: 896
1417 height: 504
1418 1280:
1419 url: http://example.com/video3.mp4
1420 width: 1280
1421 height: 720
1422 1920:
1423 url: http://example.com/video4.mp4
1424 width: 1920
1425 height: 1080
1426 type:
1427 type: string
1428 example: video
1429 duration:
1430 type: string
1431 example: 01:07
1432 privacy:
1433 type: string
1434 example: public
1435 price:
1436 type: number
1437 isLocked:
1438 type: boolean
1439 VideoItemResponse:
1440 type: object
1441 properties:
1442 data:
1443 $ref: "#/components/schemas/VideoItem"