{ "info": { "_postman_id": "2441e6fc-536c-4a04-b2e5-cec49467247c", "name": "Envoy Platform: Partner API", "description": "\nWelcome to out product technical documentation. Head\n[here](https://envoytechnology.atlassian.net/wiki/spaces/EOD/pages/80379905/Tech+one+pager)\nif need more context on out product.\n\n**Base URL**\n\nBase URL to our API is `https://api.envoy.is/partner`\n\n**Requirement**\n\nTo use our API, you will need to add your API key into `x-api-key` header to every request.\n\nYou can find your key inside your [Dashboard](https://dashboard.envoy.is).\n", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json", "_exporter_id": "33211701", "_collection_link": "https://martian-escape-418028.postman.co/workspace/envoy~ac34fa21-e234-43eb-8e35-6549e4049d30/collection/33211701-2441e6fc-536c-4a04-b2e5-cec49467247c?action=share&source=collection_link&creator=33211701" }, "item": [ { "name": "create-link", "item": [ { "name": "Create Link - general", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link", "description": "On the right there are some basic example of creating a gift link.\n\nPlease consult the request schema for other parameters and their funcionalities. Those examples only a highlight the basic functionalities\n\n\n⚠️ **Make sure you take into account the 403** - no remaining user quotas use case.\nYou can use the `user-quota/{user-id}` function to check user quotas in advance if needed." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": \"\",\n \"user_remaining_quota\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Quota exhausted", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] }, { "name": "Create Link - VIDEO", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"VIDEO\",\n \"content_name\": \"Test Content\",\n \"content_description\": \"Description\",\n \"common\": {\n \"source\": \"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4\",\n \"source_is_redirect\": false,\n \"poster\": \"https://picsum.photos/id/237/200/300\"\n }\n },\n \"sharer_id\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link", "description": "On the right there are some basic example of creating a gift link.\n\nPlease consult the request schema for other parameters and their funcionalities. Those examples only a highlight the basic functionalities\n\n\n⚠️ **Make sure you take into account the 403** - no remaining user quotas use case.\nYou can use the `user-quota/{user-id}` function to check user quotas in advance if needed." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": \"\",\n \"user_remaining_quota\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Quota exhausted", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] }, { "name": "Create Link - AUDIO", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"AUDIO\",\n \"content_name\": \"Test Content\",\n \"content_description\": \"Description\",\n \"common\": {\n \"source\": \"https://www.learningcontainer.com/wp-content/uploads/2020/02/Kalimba.mp3\",\n \"source_is_redirect\": false,\n \"poster\": \"https://picsum.photos/id/237/200/300\"\n }\n },\n \"sharer_id\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link", "description": "On the right there are some basic example of creating a gift link.\n\nPlease consult the request schema for other parameters and their funcionalities. Those examples only a highlight the basic functionalities\n\n\n⚠️ **Make sure you take into account the 403** - no remaining user quotas use case.\nYou can use the `user-quota/{user-id}` function to check user quotas in advance if needed." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": \"\",\n \"user_remaining_quota\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Quota exhausted", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] }, { "name": "Create Link - PLAIN HTML", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"HTML_SOURCE\",\n \"content_name\": \"Test Content\",\n \"content_description\": \"Description\",\n \"common\": {\n \"source\": \"

Hello World

\"\n }\n },\n \"sharer_id\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link", "description": "On the right there are some basic example of creating a gift link.\n\nPlease consult the request schema for other parameters and their funcionalities. Those examples only a highlight the basic functionalities\n\n\n⚠️ **Make sure you take into account the 403** - no remaining user quotas use case.\nYou can use the `user-quota/{user-id}` function to check user quotas in advance if needed." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": \"\",\n \"user_remaining_quota\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Quota exhausted", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] }, { "name": "Create Link - SOURCE HTML", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"HTML_SOURCE\",\n \"content_name\": \"Test Content\",\n \"content_description\": \"Description\",\n \"common\": {\n \"source\": \"https://en.wikipedia.org/wiki/Napoleon\"\n }\n },\n \"sharer_id\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link", "description": "On the right there are some basic example of creating a gift link.\n\nPlease consult the request schema for other parameters and their funcionalities. Those examples only a highlight the basic functionalities\n\n\n⚠️ **Make sure you take into account the 403** - no remaining user quotas use case.\nYou can use the `user-quota/{user-id}` function to check user quotas in advance if needed." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": \"\",\n \"user_remaining_quota\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Quota exhausted", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] }, { "name": "Create Link - SCREENSHOT", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"Test Content\",\n \"content_description\": \"Description\",\n \"common\": {\n \"source\": \"https://en.wikipedia.org/wiki/Napoleon\"\n }\n },\n \"sharer_id\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link", "description": "On the right there are some basic example of creating a gift link.\n\nPlease consult the request schema for other parameters and their funcionalities. Those examples only a highlight the basic functionalities\n\n\n⚠️ **Make sure you take into account the 403** - no remaining user quotas use case.\nYou can use the `user-quota/{user-id}` function to check user quotas in advance if needed." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": \"\",\n \"user_remaining_quota\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Quota exhausted", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] }, { "name": "Create Link - SCREENSHOT Base64", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"Test Content\",\n \"content_description\": \"Description\",\n \"base64_file\": \"base64_image_string\"\n },\n \"sharer_id\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link", "description": "On the right there are some basic example of creating a gift link.\n\nPlease consult the request schema for other parameters and their funcionalities. Those examples only a highlight the basic functionalities\n\n\n⚠️ **Make sure you take into account the 403** - no remaining user quotas use case.\nYou can use the `user-quota/{user-id}` function to check user quotas in advance if needed." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": \"\",\n \"user_remaining_quota\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Quota exhausted", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] }, { "name": "Create Link - content blocked by e-mail entering", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"VIDEO\",\n \"content_name\": \"Test Content\",\n \"content_description\": \"Description\",\n \"common\": {\n \"source\": \"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4\",\n \"source_is_redirect\": false,\n \"poster\": \"https://picsum.photos/id/237/200/300\"\n },\n \"mandatory_email\": true,\n \"modal_title\": \"Please fill your email\",\n \"button_title\": \"Unlock!\"\n },\n \"sharer_id\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link", "description": "On the right there are some basic example of creating a gift link.\n\nPlease consult the request schema for other parameters and their funcionalities. Those examples only a highlight the basic functionalities\n\n\n⚠️ **Make sure you take into account the 403** - no remaining user quotas use case.\nYou can use the `user-quota/{user-id}` function to check user quotas in advance if needed." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": \"\",\n \"user_remaining_quota\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Quota exhausted", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] }, { "name": "Create Link - content restrictions", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"VIDEO\",\n \"content_name\": \"Test Content\",\n \"content_description\": \"Description\",\n \"common\": {\n \"source\": \"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4\",\n \"source_is_redirect\": false,\n \"poster\": \"https://picsum.photos/id/237/200/300\"\n },\n \"time_limit\": 10,\n \"open_quota\": 2\n },\n \"sharer_id\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link", "description": "On the right there are some basic example of creating a gift link.\n\nPlease consult the request schema for other parameters and their funcionalities. Those examples only a highlight the basic functionalities\n\n\n⚠️ **Make sure you take into account the 403** - no remaining user quotas use case.\nYou can use the `user-quota/{user-id}` function to check user quotas in advance if needed." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": \"\",\n \"user_remaining_quota\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Quota exhausted", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"content_setting\": {\n \"content_type\": \"SCREENSHOT\",\n \"content_name\": \"\",\n \"content_description\": \"\",\n \"common\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"time_limit\": \"\",\n \"time_start\": \"\",\n \"available_from\": \"\",\n \"available_to\": \"\",\n \"video_orientation\": \"horizontal\",\n \"preview_title\": \"\",\n \"preview_description\": \"\",\n \"preview_image\": \"\",\n \"mandatory_email\": false,\n \"modal_title\": \"\",\n \"button_text\": \"\",\n \"content_protection\": {\n \"drm_player\": {\n \"server_name\": \"\",\n \"server_certificate\": \"\"\n },\n \"media\": {\n \"source\": \"\",\n \"source_is_redirect\": false,\n \"poster\": \"\"\n },\n \"player\": \"\",\n \"drm_headers\": {}\n }\n },\n \"sharer_id\": \"\",\n \"autoplay\": \"\",\n \"lifespan_after_click\": {\n \"unit\": \"HOUR\",\n \"value\": 4\n },\n \"open_quota\": \"\",\n \"extra\": {},\n \"is_sandbox\": \"\",\n \"labels\": [\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n },\n {\n \"text\": \"\",\n \"color\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/create-link" }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "user-quota", "item": [ { "name": "{user_id}", "item": [ { "name": "Get User Remaining Quota", "request": { "method": "GET", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-quota/:user_id?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "user-quota", ":user_id" ], "query": [ { "key": "sandbox", "value": "false", "description": "If to get sandbox quotas" } ], "variable": [ { "key": "user_id", "value": "", "description": "(Required) " } ] }, "description": "Get the user remaining quota for creating gift links\n\n\n✅ **Recommendations**:\n\n\n**Check user quotas** can be called at app startup/refresh, but the value should be cached.\nThere is no point in checking it every time.\n\n\n **User quota** changes only after gift link creation, so it only need to be checked once\n at the beginning and then checked again after the gift link is created." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-quota/:user_id?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "user-quota", ":user_id" ], "query": [ { "key": "sandbox", "value": "false", "description": "If to get sandbox quotas" } ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"userId\": \"\",\n \"userRemainingQuota\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "GET", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-quota/:user_id?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "user-quota", ":user_id" ], "query": [ { "key": "sandbox", "value": "false", "description": "If to get sandbox quotas" } ], "variable": [ { "key": "user_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-quota/:user_id?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "user-quota", ":user_id" ], "query": [ { "key": "sandbox", "value": "false", "description": "If to get sandbox quotas" } ], "variable": [ { "key": "user_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] } ] } ] }, { "name": "pixel-event", "item": [ { "name": "Pixel Event - general", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event_name\": \"\",\n \"lead_uuid\": \"\",\n \"sharer_user_id\": \"\",\n \"share_link_hash\": \"\",\n \"extra\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pixel-event?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "pixel-event" ], "query": [ { "key": "sandbox", "value": "false", "description": "If sandbox event" } ] }, "description": "Envoy Pixel API enables you to share analytics events with us.\n\nThis is useful for events that are in your environment, namely your website or mobile app.\n[See our documentation](https://envoytechnology.atlassian.net/wiki/spaces/~624484c08678e900705a5762/pages/3932165/Embedding+the+Envoy+Pixel)\n on Pixel for more details." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event_name\": \"\",\n \"lead_uuid\": \"\",\n \"sharer_user_id\": \"\",\n \"share_link_hash\": \"\",\n \"extra\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pixel-event?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "pixel-event" ], "query": [ { "key": "sandbox", "value": "false", "description": "If sandbox event" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event_name\": \"\",\n \"lead_uuid\": \"\",\n \"sharer_user_id\": \"\",\n \"share_link_hash\": \"\",\n \"extra\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pixel-event?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "pixel-event" ], "query": [ { "key": "sandbox", "value": "false", "description": "If sandbox event" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event_name\": \"\",\n \"lead_uuid\": \"\",\n \"sharer_user_id\": \"\",\n \"share_link_hash\": \"\",\n \"extra\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pixel-event?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "pixel-event" ], "query": [ { "key": "sandbox", "value": "false", "description": "If sandbox event" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] }, { "name": "Pixel Event - custom event", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event_name\": \"Ad click\",\n \"sharer_user_id\": \"1\",\n \"share_link_hash\": \"\",\n \"extra\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pixel-event?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "pixel-event" ], "query": [ { "key": "sandbox", "value": "false", "description": "If sandbox event" } ] }, "description": "Envoy Pixel API enables you to share analytics events with us.\n\nThis is useful for events that are in your environment, namely your website or mobile app.\n[See our documentation](https://envoytechnology.atlassian.net/wiki/spaces/~624484c08678e900705a5762/pages/3932165/Embedding+the+Envoy+Pixel)\n on Pixel for more details." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event_name\": \"\",\n \"lead_uuid\": \"\",\n \"sharer_user_id\": \"\",\n \"share_link_hash\": \"\",\n \"extra\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pixel-event?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "pixel-event" ], "query": [ { "key": "sandbox", "value": "false", "description": "If sandbox event" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event_name\": \"\",\n \"lead_uuid\": \"\",\n \"sharer_user_id\": \"\",\n \"share_link_hash\": \"\",\n \"extra\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pixel-event?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "pixel-event" ], "query": [ { "key": "sandbox", "value": "false", "description": "If sandbox event" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event_name\": \"\",\n \"lead_uuid\": \"\",\n \"sharer_user_id\": \"\",\n \"share_link_hash\": \"\",\n \"extra\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pixel-event?sandbox=false", "host": [ "{{baseUrl}}" ], "path": [ "pixel-event" ], "query": [ { "key": "sandbox", "value": "false", "description": "If sandbox event" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "user-rewards", "item": [ { "name": "{user_id}", "item": [ { "name": "Get User Rewards", "request": { "method": "GET", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-rewards/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "user-rewards", ":user_id" ], "variable": [ { "key": "user_id", "value": "", "description": "(Required) " } ] }, "description": "Check if a specific user has any claimed rewards\n\n[See our documentation](https://envoytechnology.atlassian.net/wiki/spaces/EOD/pages/80773121/Implementing+rewards)\n\n\n✅ **Recommendations**:\n\n**Check user rewards** should be called at some time intervals, e.g. 1-2 hours,\n because the rewards are counted asynchronously, so there is no need to check it every\ntime the application is started/refreshed." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-rewards/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "user-rewards", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"userId\": \"\",\n \"rewardAvailable\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "GET", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-rewards/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "user-rewards", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-rewards/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "user-rewards", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "Claim User Reward", "request": { "method": "POST", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/user-rewards", "description": "Claim all rewards available for a specific user\n\n ⚠️ **Lookout for rewardsClaimed** - rewardsClaimed returns the exact number of rewards claimed, this can be greater than one." }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/user-rewards" }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"rewardsClaimed\": \"\"\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/user-rewards" }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": "{{baseUrl}}/user-rewards" }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] } ] }, { "name": "user-current-rewards", "item": [ { "name": "{user_id}", "item": [ { "name": "User Current Rewards", "request": { "method": "GET", "header": [ { "key": "x-api-key", "value": "{{apiKey}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-current-rewards/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "user-current-rewards", ":user_id" ], "variable": [ { "key": "user_id", "value": "", "description": "(Required) " } ] }, "description": "Check the user's current progress in rewars unlocking.\n\nThis returns information regarding:\n - How many rewards were unlocked by this user\n - How many rewards this user can still unlock\n - How many actions this user needs to complete until the next reward is unlocked" }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-current-rewards/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "user-current-rewards", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"earnedThisPeriod\": \"\",\n \"earnableLeft\": \"\",\n \"eventCount\": {\n \"completed\": \"\",\n \"leftToReward\": \"\",\n \"percentageDone\": \"\"\n }\n}" }, { "name": "Client is not Authorized", "originalRequest": { "method": "GET", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-current-rewards/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "user-current-rewards", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "x-api-key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user-current-rewards/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "user-current-rewards", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\"\n }\n ]\n}" } ] } ] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://api.envoy.is/partner" }, { "key": "apiKey", "value": "", "type": "string" } ] }