From 97e02094f38a4456ab70c180cf932b73253d73f1 Mon Sep 17 00:00:00 2001 From: pabloFuente Date: Thu, 22 Oct 2020 11:02:40 +0200 Subject: [PATCH] openvidu-server: Postman collection --- .../OpenVidu.postman_collection.json | 1120 +++++++++++++++++ 1 file changed, 1120 insertions(+) create mode 100644 openvidu-server/src/main/resources/OpenVidu.postman_collection.json diff --git a/openvidu-server/src/main/resources/OpenVidu.postman_collection.json b/openvidu-server/src/main/resources/OpenVidu.postman_collection.json new file mode 100644 index 00000000..86399bcd --- /dev/null +++ b/openvidu-server/src/main/resources/OpenVidu.postman_collection.json @@ -0,0 +1,1120 @@ +{ + "info": { + "_postman_id": "b2fbd114-3827-4117-8281-a16afaf81dcc", + "name": "OpenVidu REST API", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "POST Session", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mediaMode\": \"ROUTED\",\n \"recordingMode\": \"MANUAL\",\n \"customSessionId\": \"TestSession\",\n \"defaultOutputMode\": \"COMPOSED\",\n \"defaultRecordingLayout\": \"BEST_FIT\",\n \"defaultCustomLayout\": \"CUSTOM_LAYOUT\"\n}" + }, + "url": { + "raw": "https://localhost:4443/openvidu/api/sessions", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "sessions" + ] + } + }, + "response": [] + }, + { + "name": "GET Session/ID", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/sessions/ID?webRtcStats=false&pendingConnections=true", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "sessions", + "ID" + ], + "query": [ + { + "key": "webRtcStats", + "value": "false" + }, + { + "key": "pendingConnections", + "value": "true" + } + ] + } + }, + "response": [] + }, + { + "name": "GET Sessions", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/sessions?webRtcStats=false&pendingConnections=true", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "sessions" + ], + "query": [ + { + "key": "webRtcStats", + "value": "false" + }, + { + "key": "pendingConnections", + "value": "true" + } + ] + } + }, + "response": [] + }, + { + "name": "DELETE Session/ID", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "DELETE", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/sessions/ID", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "sessions", + "ID" + ] + } + }, + "response": [] + }, + { + "name": "POST Connection", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "type": "text", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"asdf\",\n \"role\": \"PUBLISHER\",\n \"data\": \"SERVER_DATA\",\n \"record\": true,\n \"kurentoOptions\": {\n \"videoMaxRecvBandwidth\": 1000,\n \"videoMinRecvBandwidth\": 300,\n \"videoMaxSendBandwidth\": 1000,\n \"videoMinSendBandwidth\": 300,\n \"allowedFilters\": [\n \"GStreamerFilter\",\n \"ZBarFilter\"\n ]\n },\n \"rtspUri\": \"rtsp://your.camera.ip.sdp\",\n \"adaptativeBitrate\": true,\n \"onlyPlayWithSubscribers\": true,\n \"networkCache\": 2000\n}" + }, + "url": { + "raw": "https://localhost:4443/openvidu/api/sessions/TestSession/connection", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "sessions", + "TestSession", + "connection" + ] + } + }, + "response": [] + }, + { + "name": "GET Connection/ID", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/sessions/ID/connection/ID", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "sessions", + "ID", + "connection", + "ID" + ] + } + }, + "response": [] + }, + { + "name": "GET Connections", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/sessions/ID/connection", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "sessions", + "ID", + "connection" + ] + } + }, + "response": [] + }, + { + "name": "PATCH Connection", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"role\": \"MODERATOR\",\n \"record\": false\n}" + }, + "url": { + "raw": "https://localhost:4443/openvidu/api/sessions/TestSession/connection/con_SKoAiag7OO", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "sessions", + "TestSession", + "connection", + "con_SKoAiag7OO" + ] + } + }, + "response": [] + }, + { + "name": "DELETE Connection/ID", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "DELETE", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/sessions/ID/connection/ID", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "sessions", + "ID", + "connection", + "ID" + ] + } + }, + "response": [] + }, + { + "name": "POST Recording Start", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "type": "text", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"session\":\"TestSession\",\n \"name\":\"MyRecording\",\n \"outputMode\":\"COMPOSED\",\n \"hasAudio\": true,\n \"hasVideo\": true,\n \"recordingLayout\":\"BEST_FIT\",\n \"customLayout\":\"\",\n \"resolution\": \"1280x720\"\n}" + }, + "url": { + "raw": "https://localhost:4443/openvidu/api/recordings/start", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "recordings", + "start" + ] + } + }, + "response": [] + }, + { + "name": "POST Recording Stop", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "type": "text", + "value": "application/json" + } + ], + "url": { + "raw": "https://localhost:4443/openvidu/api/recordings/stop/ID", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "recordings", + "stop", + "ID" + ] + } + }, + "response": [] + }, + { + "name": "GET Recording/ID", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/recordings/ID", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "recordings", + "ID" + ] + } + }, + "response": [] + }, + { + "name": "GET Recordings", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/recordings", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "recordings" + ] + } + }, + "response": [] + }, + { + "name": "DELETE Recording", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "DELETE", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/recordings/ID", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "recordings", + "ID" + ] + } + }, + "response": [] + }, + { + "name": "GET MediaNode/ID", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/media-nodes/ID?sessions=true&extra-info=false", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "media-nodes", + "ID" + ], + "query": [ + { + "key": "sessions", + "value": "true" + }, + { + "key": "extra-info", + "value": "false" + } + ] + } + }, + "response": [] + }, + { + "name": "GET MediaNodes", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/media-nodes?sessions=true&extra-info=false", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "media-nodes" + ], + "query": [ + { + "key": "sessions", + "value": "true" + }, + { + "key": "extra-info", + "value": "false" + } + ] + } + }, + "response": [] + }, + { + "name": "POST Media Node", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "type": "text", + "value": "application/json" + } + ], + "url": { + "raw": "https://localhost:4443/openvidu/api/media-nodes?wait=true", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "media-nodes" + ], + "query": [ + { + "key": "wait", + "value": "true" + } + ] + } + }, + "response": [] + }, + { + "name": "DELETE Media Node", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "DELETE", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/media-nodes/ID?wait=true&deletion-strategy=when-no-sessions", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "media-nodes", + "ID" + ], + "query": [ + { + "key": "wait", + "value": "true" + }, + { + "key": "deletion-strategy", + "value": "when-no-sessions" + } + ] + } + }, + "response": [] + }, + { + "name": "PATCH Media Node", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "PATCH", + "header": [ + { + "key": "Content-Type", + "type": "text", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"terminating\"\n}" + }, + "url": { + "raw": "https://localhost:4443/openvidu/api/media-nodes/kms_LmVJiQpm", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "media-nodes", + "kms_LmVJiQpm" + ] + } + }, + "response": [] + }, + { + "name": "PUT Media Nodes", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "PUT", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/media-nodes", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "media-nodes" + ] + } + }, + "response": [] + }, + { + "name": "POST Token", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "type": "text", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"session\": \"TestSession\",\n \"role\": \"PUBLISHER\",\n \"data\": \"SERVER_DATA\",\n \"record\": true,\n \"kurentoOptions\": {\n \"videoMaxRecvBandwidth\": 1000,\n \"videoMinRecvBandwidth\": 300,\n \"videoMaxSendBandwidth\": 1000,\n \"videoMinSendBandwidth\": 300,\n \"allowedFilters\": [ \"GStreamerFilter\", \"ZBarFilter\" ]\n }\n}" + }, + "url": { + "raw": "https://localhost:4443/openvidu/api/tokens", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "tokens" + ] + } + }, + "response": [] + }, + { + "name": "DELETE Stream/ID", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "DELETE", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/sessions/ID/stream/ID", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "sessions", + "ID", + "stream", + "ID" + ] + } + }, + "response": [] + }, + { + "name": "POST Signal", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "type": "text", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"session\":\"TestSession\",\n \"to\": [],\n \"type\":\"MY_TYPE\",\n \"data\":\"This is my signal data\"\n}" + }, + "url": { + "raw": "https://localhost:4443/openvidu/api/signal", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "signal" + ] + } + }, + "response": [] + }, + { + "name": "GET Config", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/config", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "config" + ] + } + }, + "response": [] + }, + { + "name": "GET Health", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "GET", + "header": [], + "url": { + "raw": "https://localhost:4443/openvidu/api/health", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "health" + ] + } + }, + "response": [] + }, + { + "name": "POST Restart", + "request": { + "auth": { + "type": "basic", + "basic": [ + { + "key": "password", + "value": "MY_SECRET", + "type": "string" + }, + { + "key": "username", + "value": "OPENVIDUAPP", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "type": "text", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"OPENVIDU_SECRET\":\"MY_SECRET\",\n \"OPENVIDU_CDR\":true,\n \"OPENVIDU_RECORDING\":true,\n \"OPENVIDU_RECORDING_PUBLIC_ACCESS\":true,\n \"OPENVIDU_RECORDING_NOTIFICATION\":\"publisher_moderator\",\n \"OPENVIDU_RECORDING_PATH\":\"/opt/openvidu/recordings\",\n \"OPENVIDU_RECORDING_CUSTOM_LAYOUT\":\"/opt/openvidu/custom-layout\",\n \"OPENVIDU_RECORDING_AUTOSTOP_TIMEOUT\":120,\n \"OPENVIDU_WEBHOOK\":false,\n \"OPENVIDU_WEBHOOK_ENDPOINT\":\"http://localhost:7777/webhook/\",\n \"OPENVIDU_WEBHOOK_HEADERS\":[\n \"Authorization: Basic T1BFTlZJRFVBUFA6TVlfU0VDUkVU\"\n ],\n \"OPENVIDU_WEBHOOK_EVENTS\":[\n \"recordingStatusChanged\"\n ],\n \"OPENVIDU_STREAMS_VIDEO_MAX_RECV_BANDWIDTH\":1000,\n \"OPENVIDU_STREAMS_VIDEO_MIN_RECV_BANDWIDTH\":300,\n \"OPENVIDU_STREAMS_VIDEO_MAX_SEND_BANDWIDTH\":1000,\n \"OPENVIDU_STREAMS_VIDEO_MIN_SEND_BANDWIDTH\":300,\n \"OPENVIDU_SESSIONS_GARBAGE_INTERVAL\":900,\n \"OPENVIDU_SESSIONS_GARBAGE_THRESHOLD\":3600,\n \"OPENVIDU_PRO_STATS_MONITORING_INTERVAL\":30,\n \"OPENVIDU_PRO_STATS_WEBRTC_INTERVAL\":20\n}" + }, + "url": { + "raw": "https://localhost:4443/openvidu/api/restart", + "protocol": "https", + "host": [ + "localhost" + ], + "port": "4443", + "path": [ + "openvidu", + "api", + "restart" + ] + } + }, + "response": [] + } + ], + "protocolProfileBehavior": {} +} \ No newline at end of file