-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
5068 lines (5019 loc) · 153 KB
/
openapi.yaml
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: REST API Reference
description: >-
By using the REST API, you can integrate our Co-browsing technology into
your own application or build a thin layer around our technology. You can
completely customize Surfly and automate the management of client and agent
creation through the REST API.
The Surfly REST API allows you to integrate the functionality of our
dashboard in a programmatic manner. With our API you can do the following
things:
* **Agents** - Manage your agents
* **Sessions** - Get an overview of all your sessions
* **Screenshots** - Create screenshots of your co-browsing sessions
* **Clients** - Create new clients *(reseller only)*
* **Servers** - Get a list of all available Surfly public cloud servers
* **History** - Get an overview of sessions history
* **Webhooks** - Manage your webhooks
Below you can find detailed code examples illustrating how to make the REST
calls. You will need your REST API key (which can be found in the
integration panel, just below the widget code).
> The rate limit for making REST API calls is 100 req/min/IP address
version: '2.0'
x-konfig-ignore:
potential-incorrect-type: true
servers:
- url: https://surfly.com/v2
variables:
defaultHost:
default: www.example.com
tags:
- description: >-
> (2018-03-19) `RESELLER_KEY` is deprecated. In order to make old API
calls compatible, we replaced the placeholder with the keyword `all`
name: Clients
- description: ''
name: Agents
- description: ''
name: Sessions
- description: ''
name: Webhooks
- description: ''
name: Company
- description: ''
name: Screenshots
- description: ''
name: History
- description: ''
name: Servers
paths:
/agents/?api_key={API_KEY}:
get:
tags:
- Agents
summary: List
operationId: Agents_getList
security:
- api_key: []
description: List all agents
parameters:
- description: >-
Agents that are ready to take a call. Depends on `available` field
value and online status.
name: free
in: query
style: form
explode: true
schema:
type: boolean
example: true
responses:
'200':
description: Successful request
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsGetListResponse'
example:
- agent_id: 1
agent_name: Peter Pan
agent_email: peter@neverland.net
last_login: '2020-02-03T11:03:39.323310Z'
role: agent
available: true
post:
tags:
- Agents
summary: Create
operationId: Agents_registerNewAgent
security:
- api_key: []
description: Create a new AGENT
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsRegisterNewAgentRequest'
example:
username: Peter Pan
agent_email: peter@neverland.net
password: Pass@123
role: admin
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsRegisterNewAgentResponse'
example:
agent_id: '1'
/agents/{AGENT_ID}/?api_key={API_KEY}:
get:
tags:
- Agents
summary: Get by id
operationId: Agents_getById
description: Get information about a certain AGENT by `AGENT_ID`
parameters:
- name: API_KEY
in: path
required: true
schema:
type: string
example: 3b57bd2db21c46d2875508b982968d26
- name: AGENT_ID
in: path
required: true
schema:
type: string
example: '2'
responses:
'200':
description: Successful response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsGetByIdResponse'
example:
agent_id: 2
agent_name: John Doe
agent_email: john.doe@example.com
last_login: '2020-02-03T11:03:39.323310Z'
role: agent
available: true
put:
tags:
- Agents
summary: Update
operationId: Agents_updateAgent
security:
- api_key: []
description: Update an AGENT by `AGENT_ID`
parameters:
- description: Id of the agent to update
name: AGENT_ID
in: path
required: true
schema:
type: string
example: '2'
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsUpdateAgentRequest'
example:
username: Peter
available: true
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsUpdateAgentResponse'
example:
agent_name: Peter
agent_id: 2
agent_email: peter@neverland.com
available: true
delete:
tags:
- Agents
summary: Delete
operationId: Agents_removeAgent
security:
- api_key: []
description: Remove an AGENT by `AGENT_ID`
parameters:
- description: ''
name: AGENT_ID
in: path
required: true
schema:
type: string
example: '2'
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsRemoveAgentResponse'
example:
response: Agent has been removed successfully
/agents/access-token/?api_key={API_KEY}:
post:
tags:
- Agents
summary: Generate an access token
operationId: Agents_generateAccessToken
security:
- api_key: []
description: >-
Generate a temporary access token for a given agent.
Surfly generates a unique access token for the specified user and
returns it in a response. The token expires automatically **24 hours**
after it is first created. Within that period, it can be used to
construct [Embed API](/embed.html) links, but after that a new token has
to be generated. Note that unless `force_new` parameter is set, Surfly
will try to return an existing token. If the existing token is due to
expire in less than 5 minutes, the new token will be generated even if
`force_new` is set to false.
Note that 24 hours expiration time is mainly for performance
optimization: the integrating app doesn't have to generate a token on
each page load. Instead, it can generate it (for example) when user logs
in, and cache it for a day.
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsGenerateAccessTokenRequest'
example:
email: agent@neverland.net
name: Ethan Hunt
role: agent
required: true
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsGenerateAccessTokenResponse'
example:
user_created: true
agent_token: t0aae2b2454c64b9a87b83ec09647dd9e
expires_in: 86400
agent_id: 1337
agent_role: agent
'404':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AgentsGenerateAccessToken404Response'
example:
errors:
agent_id:
- Agent was not found
/sessions/?api_key={API_KEY}:
get:
tags:
- Sessions
summary: List
operationId: Sessions_getAll
security:
- api_key: []
description: List all sessions
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SessionsGetAllResponse'
example:
- tags: []
id: fvFkrL4saf52nuFh4GP9oQw
session_id: fvFkrL4saf52nuFh4GP9oQw
formatted_id: 123-123-123
agent_id: null
follower_link: https://surfly.com/123-123-123
cobro_server_name: session.surfly.com
start_time: '2017-04-21T13:55:08.251918Z'
duration: null
participant_num: 0
end_time: null
successful_start: null
queue_id: 0
pin: null
queued: false
waiting_time: null
start_url: >-
https://surfly.com.com/test/widget/?widget_key=3b57bd2db21c46d2875508b982968d26&hide_support_button_when_unavailable=false&hide_until_agent_joins=false
meta: '{}'
opentok_archive_id: null
space: null
options:
sounds_enabled: true
videochat: true
allowlist: '[]'
anyone_can_deactivate_space: false
session_autorestore_enabled: true
cookie_transfer_enabled: true
cookie_transfer_scopes: []
widget_key: 0
cookie_transfer_proxying: false
chat_logs_enabled: false
host_switching_allowed: true
start_muted: false
format_session_id: true
end_redirect_enabled: false
cookie_transfer_urls: []
start_with_invite_modal: true
theme_font_size: 14
theme_font_color: '#FFFFFF'
verbose_console: false
new_urls_allowed: true
end_of_session_popup_url: ''
start_with_chat_open: false
hide_support_button_when_unavailable: false
white_label: false
blocklist: '[]'
support_button_position: bottomleft
filesharing_enabled: true
hide_until_agent_joins: false
hidden: false
original_file_download_allowed: false
hide_session_ui: false
invitations_allowed: true
auto_start: false
theme_font_background: '#cc0000'
block_until_agent_joins: false
follower_redirect_url: ''
embedded_sessions_only: false
key_combo_to_start: true
leader_redirect_url: ''
post:
tags:
- Sessions
summary: Create
operationId: Sessions_generateNewSession
security:
- api_key: []
description: Create a new session
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SessionsGenerateNewSessionRequest'
example:
tags:
- tag1
- tag2
url: http://www.surfly.com/
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SessionsGenerateNewSessionResponse'
example:
tags: []
id: fvFkrL4saf52nuFh4GP9oQwX
session_id: fvFkrL4saf52nuFh4GP9oQw
formatted_id: 123-123-123
agent_id: null
follower_link: https://surfly.com/123-123-123
leader_link: https://surfly.com/mUBRJyslQStVXPEwUwFyQ
cobro_server_name: session.surfly.com
start_time: '2017-04-21T13:55:08.251918Z'
duration: null
end_time: null
queue_id: 0
pin: null
queued: false
waiting_time: null
start_url: https://example.com
meta: '{}'
options:
sounds_enabled: true
videochat: true
allowlist: '[]'
anyone_can_deactivate_space: false
session_autorestore_enabled: true
cookie_transfer_enabled: true
cookie_transfer_scopes: []
widget_key: 0
cookie_transfer_proxying: false
chat_logs_enabled: false
host_switching_allowed: true
start_muted: false
format_session_id: true
end_redirect_enabled: false
cookie_transfer_urls: []
start_with_invite_modal: true
theme_font_size: 14
theme_font_color: '#FFFFFF'
verbose_console: false
new_urls_allowed: true
end_of_session_popup_url: ''
start_with_chat_open: false
hide_support_button_when_unavailable: false
white_label: false
blocklist: '[]'
support_button_position: bottomleft
filesharing_enabled: true
hide_until_agent_joins: false
hidden: false
original_file_download_allowed: false
hide_session_ui: false
invitations_allowed: true
auto_start: false
theme_font_background: '#cc0000'
block_until_agent_joins: false
follower_redirect_url: ''
embedded_sessions_only: false
key_combo_to_start: true
leader_redirect_url: ''
/sessions/?api_key={api_key}&active_session={active_session}&agent_id={agent_id}&year={year}&month={month}&pin={pin}&tags={tags}:
get:
tags:
- Sessions
summary: Filter
operationId: Sessions_filter
security:
- api_key: []
description: Filter session. For example, list all active sessions
parameters:
- description: Filter active or inactive sessions
name: active_session
in: query
required: true
schema:
type: boolean
example: true
- description: Filter by ID of the agent who joined/started a session
name: agent_id
in: query
required: true
schema:
type: number
format: double
example: 1
- description: Filter by year
name: year
in: query
required: true
schema:
type: number
format: double
example: 2020
- description: Filter by month
name: month
in: query
required: true
schema:
type: number
format: double
example: 10
- description: Filter by PIN number (useful in combination with `active_session`)
name: pin
in: query
required: true
schema:
type: number
format: double
example: 1234
- description: Filter by tag. Supports multiple comma separated tags at once
name: tags
in: query
required: true
schema:
type: string
example: tag1,tag2
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SessionsFilterResponse'
example:
- tags: []
id: fvFkrL4saf52nuFh4GP9oQwX
session_id: fvFkrL4saf52nuFh4GP9oQw
formatted_id: 123-123-123
agent_id: null
follower_link: https://surfly.com/123-123-123
cobro_server_name: session.surfly.com
start_time: '2017-04-21T13:55:08.251918Z'
duration: null
participant_num: 0
end_time: null
successful_start: null
queue_id: 0
pin: null
queued: false
waiting_time: null
start_url: https://example.com
meta: '{}'
opentok_archive_id: null
options:
sounds_enabled: true
videochat: true
allowlist: '[]'
anyone_can_deactivate_space: false
session_autorestore_enabled: true
cookie_transfer_enabled: true
cookie_transfer_scopes: []
widget_key: 0
cookie_transfer_proxying: false
chat_logs_enabled: false
host_switching_allowed: true
start_muted: false
format_session_id: true
end_redirect_enabled: false
cookie_transfer_urls: []
start_with_invite_modal: true
theme_font_size: 14
theme_font_color: '#FFFFFF'
verbose_console: false
new_urls_allowed: true
end_of_session_popup_url: ''
start_with_chat_open: false
hide_support_button_when_unavailable: false
white_label: false
blocklist: '[]'
support_button_position: bottomleft
filesharing_enabled: true
hide_until_agent_joins: false
hidden: false
original_file_download_allowed: false
hide_session_ui: false
invitations_allowed: true
auto_start: false
theme_font_background: '#cc0000'
block_until_agent_joins: false
follower_redirect_url: ''
embedded_sessions_only: false
key_combo_to_start: true
leader_redirect_url: ''
/sessions/{ID}/?api_key={API_KEY}:
get:
tags:
- Sessions
summary: Get by id
operationId: Sessions_getById
security:
- api_key: []
description: Get information about a session by `ID`.
parameters:
- description: >-
Id of the session. Can be a formatted ID (e.g. 123-123-123), or an
unformatted ID (e.g. fuSHr0sRQ1usugvheahwQ)
name: ID
in: path
required: true
schema:
type: string
example: fuSHr0sRQ1usugvheahwQ
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SessionsGetByIdResponse'
example:
tags: []
id: fvFkrL4saf52nuFh4GP9oQwX
session_id: fvFkrL4saf52nuFh4GP9oQw
formatted_id: 123-123-123
agent_id: 1
follower_link: https://surfly.com/123-123-123
cobro_server_name: session.surfly.com
start_time: '2017-04-21T13:55:08.251918Z'
duration: null
participant_num: 3
end_time: null
successful_start: null
queue_id: 0
pin: null
queued: false
waiting_time: null
start_url: https://example.com
meta: '{}'
opentok_archive_id: null
options:
sounds_enabled: true
videochat: true
allowlist: '[]'
anyone_can_deactivate_space: false
session_autorestore_enabled: true
cookie_transfer_enabled: true
cookie_transfer_scopes: []
widget_key: 0
cookie_transfer_proxying: false
chat_logs_enabled: false
host_switching_allowed: true
start_muted: false
format_session_id: true
end_redirect_enabled: false
cookie_transfer_urls: []
start_with_invite_modal: true
theme_font_size: 14
theme_font_color: '#FFFFFF'
verbose_console: false
new_urls_allowed: true
end_of_session_popup_url: ''
start_with_chat_open: false
hide_support_button_when_unavailable: false
white_label: false
blocklist: '[]'
support_button_position: bottomleft
filesharing_enabled: true
hide_until_agent_joins: false
hidden: false
original_file_download_allowed: false
hide_session_ui: false
invitations_allowed: true
auto_start: false
theme_font_background: '#cc0000'
block_until_agent_joins: false
follower_redirect_url: ''
embedded_sessions_only: false
key_combo_to_start: true
leader_redirect_url: ''
/sessions/{ID}/end/?api_key={API_KEY}:
post:
tags:
- Sessions
summary: End
operationId: Sessions_endById
security:
- api_key: []
description: End a session by Id
parameters:
- name: ID
in: path
required: true
schema:
type: string
example: fuSHr0sRQ1usugvheahwQ
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SessionsEndByIdResponse'
example:
tags: []
id: fvFkrL4saf52nuFh4GP9oQwX
session_id: fvFkrL4saf52nuFh4GP9oQw
formatted_id: 123-123-123
agent_id: 1
follower_link: https://surfly.com/123-123-123
cobro_server_name: session.surfly.com
start_time: '2017-04-21T13:55:08.251918Z'
duration: 10
participant_num: 3
end_time: '2017-04-21T13:55:18.251918Z'
successful_start: false
queue_id: 0
pin: null
queued: false
waiting_time: null
start_url: https://example.com
meta: '{}'
opentok_archive_id: null
options:
sounds_enabled: true
videochat: true
allowlist: '[]'
anyone_can_deactivate_space: false
session_autorestore_enabled: true
cookie_transfer_enabled: true
cookie_transfer_scopes: []
widget_key: 0
cookie_transfer_proxying: false
chat_logs_enabled: false
host_switching_allowed: true
start_muted: false
native_dialogs_enabled: 0
format_session_id: true
end_redirect_enabled: false
cookie_transfer_urls: []
start_with_invite_modal: true
theme_font_size: 14
theme_font_color: '#FFFFFF'
verbose_console: false
new_urls_allowed: true
end_of_session_popup_url: ''
start_with_chat_open: false
hide_support_button_when_unavailable: false
white_label: false
blocklist: '[]'
support_button_position: bottomleft
filesharing_enabled: true
hide_until_agent_joins: false
hidden: false
original_file_download_allowed: false
hide_session_ui: false
invitations_allowed: true
auto_start: false
session_start_confirmation: 0
theme_font_background: '#cc0000'
block_until_agent_joins: false
follower_redirect_url: ''
embedded_sessions_only: false
key_combo_to_start: true
leader_redirect_url: ''
/company/options/?api_key={api_key}:
get:
tags:
- Company
summary: Get default options
operationId: Company_getDefaultOptions
security:
- api_key: []
description: >-
Get company options. A list of all available options is available
[here](https://docs.surfly.com). Returns an object with default session
options. Plan limitations are taken into account
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGetDefaultOptionsResponse'
example:
sounds_enabled: true
videochat: true
allowlist: '[]'
post:
tags:
- Company
summary: Post options
operationId: Company_postOptions
security:
- api_key: []
description: >-
List of all available options is available
[here](https://docs.surfly.com). Sets new default options. **If any
option is missing in the request body, its value is reset to default**.
If you need to update only certain options and leave the other intact,
consider the `PATCH` method instead.
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyPostOptionsResponse'
example:
sounds_enabled: true
videochat: true
allowlist: '[]'
patch:
tags:
- Company
summary: Update default options
operationId: Company_updateDefaultOptions
security:
- api_key: []
description: >-
List of all available options is available
[here](https://docs.surfly.com). Updates values of options specified in
the request body. Other options are left intact
```
curl -X PATCH --header "Content-Type: application/json" -d
'{"start_with_chat_open": true}'
'https://surfly.com/v2/company/options/?api_key=API_KEY'
```
parameters: []
responses:
'200':
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyUpdateDefaultOptionsResponse'
example:
sounds_enabled: true
videochat: true
allowlist: '[]'
delete:
tags:
- Company
summary: Reset default options
operationId: Company_resetDefaultOptions
security:
- api_key: []
description: >-
List of all available options is available
[here](https://docs.surfly.com). Resets all session options to their
default values
parameters: []
responses:
'200':
description: ''
headers: {}
content: {}
/sessions/{ID}/screenshots/latest/?api_key={API_KEY}:
get:
tags:
- Screenshots
summary: Latest Screenshot
operationId: Screenshots_getLatest
security:
- api_key: []
description: Get latest screenshot for session by its `ID`.
parameters:
- name: ID
in: path
required: true
schema:
type: string
example: fuSHr0sRQ1usugvheahwQ
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ScreenshotsGetLatestResponse'
example:
url: http://surfly-screenshots.s3.amazonaws.com/screenshot-ID.webp
/sessions/{ID}/screenshots/create/?api_key={API_KEY}:
post:
tags:
- Screenshots
summary: Create Screenshot
operationId: Screenshots_startGeneration
security:
- api_key: []
description: >-
Start generation of screenshots. The screenshots will be created as long
as you keep getting the latest screenshots using the get latest
screenshot API, that is to stop the creation of screenshot you just have
to stop requesting the latest screenshot. There will be a new screenshot
after a set interval second. The interval will be adjusted if the given
value is lower than 5 secs. The max size of the screenshot will be
adjusted in case the requested size is more than the window size.
parameters:
- name: ID
in: path
required: true
schema:
type: string
example: fEapBPiwxSouiLcAgb2OXQ1
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ScreenshotsStartGenerationRequest'
example:
size: 1024
interval: 30
required: true
responses:
'200':
description: >-
The response message will be one of the following:
* GENERATION-STARTED (screenshot generation process started)
* ALREADY-RUNNING (screenshot generation process already running)
* FAILED-INTERNALLY (screenshot generation process failed
internally)
content:
text/plain:
schema:
$ref: '#/components/schemas/ScreenshotsStartGenerationResponse'
example: '"GENERATION-STARTED"'
/clients/all/?api_key={API_KEY}:
get:
tags:
- Clients
summary: List
operationId: Clients_getAll
security:
- api_key: []
description: Return all clients of a reseller account
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClientsGetAllResponse'
example:
- company_name: Neverland
company_plan_name: pro
client_key: AOEUaoeuntsPDe
agent_count: 15
widget_key: 24d1414c71a94cbf9f205ed4fc4999b5
rest_key: 3b57bd2db21c46d2875508b982968d26
domains: example.com, *.example.com
- company_name: DefaultCompany
company_plan_name: free
client_key: b05b45b8d4df42ba96
agent_count: 2
widget_key: c6a1333308a843cc9fb6aee2e42941d6
rest_key: 767dd31a038c4ee798c72abb4b568ade
domains: '*'
post:
tags:
- Clients
summary: Create
operationId: Clients_addNewClient
security:
- api_key: []
description: Add a new client
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientsAddNewClientRequest'
example:
company_name: Neverland
domains: '*'
agent_email: peter@mail.com
agent_name: Peter Pan
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClientsAddNewClientResponse'
example:
company_name: Neverland
client_key: fOBg4dXAPTHSoil6LywgfYA
rest_key: 22c0f77e5ca54d8fa6748f7cec4732c5
widget_key: 92cdd920f4e345768f6717b02f15dae8
/clients/all/{CLIENT_KEY}/?api_key={API_KEY}:
get:
tags:
- Clients
summary: Get by Id
operationId: Clients_infoById
security:
- api_key: []
description: Get information about a specific client by `CLIENT_KEY`
parameters:
- name: CLIENT_KEY