```json { "openapi": "3.0.0", "tags": [ { "name": "Applications", "description": "An application is composed of:\n + general information like name, description...\n + an array of binaries version\n \n > __Note that presently, only one binary version can be used by an application__" }, { "name": "Application binaries", "description": "An application binary is:\n + always related to an application\n + detailing the archive information (like the name, the list of executables it contains...)\n \n > __Note that presently, only one application binary can be used by an application__" } ], "x-tagGroups": [ { "name": "Applications", "tags": [ "Applications", "Upload progress" ] }, { "name": "Application binaries", "tags": [ "Application binaries", "Shares", "Shares - Links", "Shares - Embed", "Shares - SDK" ] } ], "info": { "title": "Furioos API", "description": "\n# Introduction\n Key features of Furioos API: \n + Manage the creation, editing, sharing and deletion of your applications \n + Get information about your applications\n \n > __Note:__ the reservations feature is not yet available through our API Services.\n\n### Notes about the Beta version\n > During the Beta period, the information in this document is not guaranteed to be up-to-date and may change without notice.\n\n## How to get started\n### Create an API Key\n + Go to the developer tab: [https://portal.furioos.com/settings/developers](https://portal.furioos.com/settings/developers)\n + Click on create a token \n + Choose your token name \n + Click on Create\n + Copy the token value\n + Insert into authentication\n\n### Upload an application\n + Call the [POST /applications](#tag/Applications/paths/~1applications/post) with your information to create a new application in your organization\n + Get the Application binary ID\n + Call the [POST /applicationsbinaries/{applicationBinaryID}/upload](#tag/Application-binaries/paths/~1applicationbinaries~1{applicationBinaryID}~1upload/post) with your application binary ID and your zip file. The request can take several minutes. \n + Call the [GET applications/progress](#tag/Applications-Upload-progress) or [GET applications/progress/applicationBinaryID](#tag/Applications-Upload-progress/paths/~1applications~1progress~1{applicationBinaryID}/get) to can see the uploading progress \n\n### Create a share link for you application\n + Call the [GET /applications](#tag/Applications/paths/~1applications/get) or [GET /applications/{applicationID}](#tag/Applications/paths/~1applications~1{applicationID}/get) to get the application binary ID\n + Call the [POST /applicationsbinaries/{applicationBinaryID}/shares/links](#tag/Application-binaries-Shares-Links/paths/~1applicationbinaries~1{applicationBinaryID}~1shares~1links/post).\n ", "version": "v1.0.3.10-beta" }, "servers": [ { "url": "https://api.furioos.com/v1" } ], "paths": { "/applications": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Applications" ], "summary": "Returns all active applications with the information of applications and application binaries.", "description": "Returns all active applications of the connected user", "responses": { "200": { "description": "Returns an applications array.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationAndApplicationBinaries" } } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } }, "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "Applications" ], "summary": "Creates a new application", "description": "Creates a new application.
Returns the information of the new application and the application binary.
Warning - You must call the POST route upload to send your archive", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InputApplication" }, "encoding": { "thumbnail": { "contentType": "image/png, image/jpeg" } } } } }, "responses": { "201": { "description": "Returns the information of the new application and the application binary", "content": { "application/json": { "schema": { "type": "object", "properties": { "application": { "$ref": "#/components/schemas/Application" }, "applicationBinary": { "$ref": "#/components/schemas/ApplicationBinary" } } } } } }, "400": { "description": "invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applications/progress": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Upload progress" ], "summary": "Returns all applications that are being uploaded with this token", "description": "Returns all applications that are being uploaded with this token
The information remain present for 60 minutes", "responses": { "200": { "description": "Returns an array of application progress.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationBinaryProgress" } } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applications/{applicationID}": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Applications" ], "summary": "Returns the information of the application and application binary", "description": "Returns the information of the application and application binary", "parameters": [ { "name": "applicationID", "in": "path", "description": "ID of the application", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an object including an application object and an array of applicationBinary object .", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationAndApplicationBinaries" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "404": { "description": "Application not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } }, "put": { "security": [ { "bearerAuth": [] } ], "tags": [ "Applications" ], "summary": "Update an application", "description": "Update an application
Returns the information updated of the application and the application binary", "parameters": [ { "name": "applicationID", "in": "path", "description": "ID of the application", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InputApplication" } } } }, "responses": { "200": { "description": "Returns the information updated of the application and the application binary.", "content": { "application/json": { "schema": { "type": "object", "properties": { "application": { "$ref": "#/components/schemas/Application" }, "applicationBinary": { "$ref": "#/components/schemas/ApplicationBinary" } } } } } }, "400": { "description": "invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "404": { "description": "Application not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } }, "delete": { "security": [ { "bearerAuth": [] } ], "tags": [ "Applications" ], "summary": "Delete an application and its application binaries", "description": "Delete an application and its applications binaries", "parameters": [ { "name": "applicationID", "in": "path", "description": "ID of the application", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ID of the deleted application.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "7GuNM6CpwX9o2fu7Y" } } } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "404": { "description": "Application not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applications/progress/{applicationBinaryID}": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Upload progress" ], "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application binary", "required": true, "schema": { "type": "string" } } ], "summary": "Returns the detail of the application that are being uploaded with this token", "description": "Returns the detail of the application that are being uploaded
The information remain present for 60 minutes", "responses": { "200": { "description": "Returns an object of application progress.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationBinaryProgress" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "404": { "description": "Application not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Application binaries" ], "summary": "Returns all active application binaries", "description": "Returns all active application binaries of the connected user", "responses": { "200": { "description": "Returns an array of the application binaries.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationBinary" } } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries/shares": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares" ], "summary": "Returns all active shares", "description": "Returns all active shares of the connected user", "responses": { "200": { "description": "Returns an array of shares.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShareLink" } } } } }, "401": { "description": "invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries/shares/{shareID}": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares" ], "summary": "Returns the share detail by ID", "description": "Returns the share detail by ID of the connected user", "parameters": [ { "name": "shareID", "in": "path", "description": "ID of the share", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an share object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLink" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "404": { "description": "Application not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } }, "delete": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares" ], "summary": "Delete a share by ID", "description": "Delete a share by ID", "parameters": [ { "name": "shareID", "in": "path", "description": "ID of the share", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ID of the deleted share.", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string", "example": "7GuNM6CpwX9o2fu7Y" } } } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries/{applicationBinaryID}": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Application binaries" ], "summary": "Returns the application binary information by ID", "description": "Returns the application binary information by ID", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application binary", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an object of applicationBinary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationBinary" } } } }, "401": { "description": "invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "404": { "description": "application not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries/{applicationBinaryID}/shares": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Application binaries" ], "summary": "Returns all active shares of the application binary", "description": "Returns all active shares of the application binary", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application binary", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an array of shares.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShareLink" } } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "404": { "description": "Application not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries/{applicationBinaryID}/shares/links": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares - Links" ], "summary": "Returns all active shares links of the application binary", "description": "Returns all active shares links of the application binary", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application binary", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an array of share links.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShareLink" } } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "404": { "description": "Application not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } }, "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares - Links" ], "summary": "Creates a share link for the application binary", "description": "Creates a share link for the application binary and returns the information", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InputShareLink" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InputShareLink" } } } }, "responses": { "201": { "description": "Returns the information of the share link.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLink" } } } }, "400": { "description": "invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries/{applicationBinaryID}/shares/embed": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares - Embed" ], "summary": "Returns all active shares embed of the application binary", "description": "Returns all active shares embed of the application binary", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application binary", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an array of shares embed.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShareEmbed" } } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "404": { "description": "Application not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } }, "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares - Embed" ], "summary": "Creates an embed share for the application binary", "description": "Creates an embed share for the application binary and returns the information", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InputShareEmbed" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InputShareEmbed" } } } }, "responses": { "201": { "description": "Returns the information of the share embed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareEmbed" } } } }, "400": { "description": "invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries/{applicationBinaryID}/shares/sdk": { "get": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares - SDK" ], "summary": "Returns all active shares SDK of the application binary", "description": "Returns all active shares SDK of the application binary", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application binary", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an array of shares SDK.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShareSDK" } } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "404": { "description": "Application not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } }, "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares - SDK" ], "summary": "Creates a share SDK for the application binary", "description": "Creates a share SDK for the application binary and returns the information of the share SDK", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InputShareSDK" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InputShareSDK" } } } }, "responses": { "201": { "description": "Returns the information of the share SDK.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareSDK" } } } }, "400": { "description": "invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries/{applicationBinaryID}/upload": { "post": { "security": [ { "bearerAuth": [] } ], "tags": [ "Application binaries" ], "summary": "Upload a zip file", "description": "Upload your application's zip file.
Returns the information of the new application and the application binary", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Local path of the application archive. Must be a zip file", "example": "users/folder/myapp.zip" } }, "required": [ "file" ] }, "encoding": { "file": { "contentType": "application/zip" } } } } }, "responses": { "200": { "description": "Returns the information of the new application and the application binary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationBinary" } } } }, "400": { "description": "invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries/{applicationBinaryID}/shares/links/{shareID}": { "put": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares - Links" ], "summary": "Update a share link of the application binary", "description": "Update a share link of the application binary and returns the information updated", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application", "required": true, "schema": { "type": "string" } }, { "name": "shareID", "in": "path", "description": "ID of share link", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InputShareLink" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InputShareLink" } } } }, "responses": { "200": { "description": "Returns the information updated of the share.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLink" } } } }, "400": { "description": "invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries/{applicationBinaryID}/shares/embed/{shareID}": { "put": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares - Embed" ], "summary": "Update a share embed of the application binary", "description": "Update a share embed of the application binary and returns the information updated", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application", "required": true, "schema": { "type": "string" } }, { "name": "shareID", "in": "path", "description": "ID of share link", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InputShareEmbed" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InputShareEmbed" } } } }, "responses": { "200": { "description": "Returns the information updated of the share.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareEmbed" } } } }, "400": { "description": "invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } }, "/applicationbinaries/{applicationBinaryID}/shares/sdk/{shareID}": { "put": { "security": [ { "bearerAuth": [] } ], "tags": [ "Shares - SDK" ], "summary": "Update a share SDK of the application binary", "description": "Update a share SDK of the application binary and returns the information updated", "parameters": [ { "name": "applicationBinaryID", "in": "path", "description": "ID of the application", "required": true, "schema": { "type": "string" } }, { "name": "shareID", "in": "path", "description": "ID of share link", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InputShareSDK" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InputShareSDK" } } } }, "responses": { "200": { "description": "Returns the information updated of the share.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareSDK" } } } }, "400": { "description": "invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "401": { "description": "Invalid api token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "403": { "description": "Invalid permission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } }, "429": { "description": "Too many request" }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response-error" } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Go to the developer tab to create your tokens https://portal.furioos.com/settings/developers
More details on https://support.furioos.com/article/settings-developers" } }, "schemas": { "Application": { "type": "object", "properties": { "_id": { "type": "string", "description": "applicationID", "example": "7dQDCuGxa86n6m7Ad" }, "name": { "type": "string", "description": "Application name", "example": "Name of my application" }, "description": { "type": "string", "description": "Description of the application", "example": "Description of the application" }, "parameters": { "type": "object", "properties": { "quality": { "type": "integer", "description": "Quality type. Must be between 0 and 4.
0- 360p/30fps
1- 480p/30fps
2- 720p/30fps
3- 1080p/60fps
", "default": 3 }, "touchConvert": { "type": "boolean", "description": "Convert touch event to mouse event", "default": false } } }, "tags": { "type": "array", "example": [], "items": { "type": "string" } }, "viewCount": { "type": "integer", "example": 4 }, "updateAt": { "type": "string", "format": "date-time", "example": "2021-05-20T13:51:08.068Z" }, "createdAt": { "type": "string", "format": "date-time", "example": "2021-05-20T10:45:00.169Z" }, "status": { "type": "string", "description": "Status of the application. 'active' or 'deleted'", "example": "active" } } }, "ApplicationBinary": { "type": "object", "properties": { "_id": { "type": "string", "description": "applicationBinaryID", "example": "Jq4rua5D8KWDnSWfB" }, "applicationID": { "type": "string", "description": "applicationID", "example": "7dQDCuGxa86n6m7Ad" }, "version": { "type": "string" }, "archive": { "type": "string", "description": "name of the archive file", "example": "myApp.zip" }, "exe": { "type": "string", "description": "name of the .exe or .bat file to be launched", "example": "folder/myApp.exe" }, "exeList": { "type": "array", "description": "name of the exe file to be launched", "example": [ "folder/myApp.exe", "folder/myApp.bat" ], "items": { "type": "string" } }, "size": { "type": "integer", "description": "size of archive in bytes", "example": 4837261812 }, "checksum": { "type": "integer", "description": "size of archive in bytes", "example": 247289271285 }, "thumbnailUrl": { "type": "string", "description": "url of thumbnail", "example": "https://storage.googleapis.com/Ayzo16uik726fdbx/qYSxd492qqxXesXLL/6Nc3pTJoMXWW3nPRp/thumbnail.image" }, "uploaded": { "type": "boolean", "description": "is true if the application has been uploaded", "example": true }, "updateAt": { "type": "string", "format": "date-time", "example": "2021-05-20T13:51:08.068Z" }, "createdAt": { "type": "string", "format": "date-time", "example": "2021-05-20T10:45:00.169Z" }, "status": { "type": "string", "description": "Status of the application. 'active' or 'deleted'", "example": "active" }, "computeTypeName": { "type": "string", "description": "Standard, High, or Extreme", "example": "Standard" } } }, "ApplicationAndApplicationBinaries": { "type": "object", "properties": { "_id": { "type": "string", "description": "applicationID", "example": "7dQDCuGxa86n6m7Ad" }, "name": { "type": "string", "description": "Application name", "example": "Name of my application" }, "description": { "type": "string", "description": "Description of the application", "example": "Description of the application" }, "parameters": { "type": "object", "properties": { "quality": { "type": "integer", "description": "Quality type. Must be between 0 and 4.
0- 360p/30fps
1- 480p/30fps
2- 720p/30fps
3- 1080p/60fps
", "default": 3 }, "touchConvert": { "type": "boolean", "description": "Convert touch event to mouse event", "default": false } } }, "tags": { "type": "array", "example": [], "items": { "type": "string" } }, "viewCount": { "type": "integer", "example": 4 }, "updateAt": { "type": "string", "format": "date-time", "example": "2021-05-20T13:51:08.068Z" }, "createdAt": { "type": "string", "format": "date-time", "example": "2021-05-20T10:45:00.169Z" }, "status": { "type": "string", "description": "Status of the application. 'active' or 'deleted'", "example": "active" }, "applicationBinaries": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationBinary" } } } }, "ApplicationBinaryProgress": { "type": "object", "properties": { "_id": { "type": "string", "description": "applicationBinaryProgressID", "example": "nsRzZzQBQ4ZB9tbYm" }, "applicationBinaryID": { "type": "string", "description": "applicationBinaryID", "example": "7dQDCuGxa86n6m7Ad" }, "filename": { "type": "string", "description": "filename in progress", "example": "filename.zip" }, "addedAt": { "type": "string", "format": "date-time", "description": "Date of added", "example": "2021-05-20T10:45:00.169Z" }, "status": { "type": "string", "description": "Status of the application uploading progress.
In progress or Complete or Aborted", "example": "In progress" }, "progress": { "type": "integer", "example": 55 }, "byteRead": { "description": "Bytes already uploaded", "type": "integer", "example": 11193456 }, "completeAt": { "type": "string", "format": "date-time", "description": "Date of completed uploading", "example": "2021-05-20T10:51:08.068Z" } } }, "ShareLink": { "type": "object", "properties": { "_id": { "type": "string", "description": "ID of the share", "example": "YYjrWfBER9thowoEM" }, "type": { "type": "integer", "description": "type of share. 1 = Share link", "example": 1 }, "applicationBinaryID": { "type": "string", "description": "ApplicationID where the share created", "example": "7dQDCuGxa86n6m7Ad" }, "linkID": { "type": "string", "description": "LinkID", "example": 455.128 }, "autorun": { "type": "boolean", "description": "Launch automatically the app if autorun is true", "default": false }, "hasPassword": { "type": "boolean", "description": "The share is protected by password if hasPassword is true", "default": false }, "sharedAt": { "type": "string", "format": "date-time", "description": "Created date", "example": "2021-05-26T08:54:20.284Z" }, "status": { "type": "string", "description": "Status of the share.", "default": "active" }, "quota": { "$ref": "#/components/schemas/ShareQuota" }, "linkUrl": { "type": "string", "description": "url of the share link", "example": "https://portal.furioos.com/share/455.128" } } }, "ShareEmbed": { "type": "object", "properties": { "_id": { "type": "string", "description": "ID of the share", "example": "YYjrWfBER9thowoEM" }, "type": { "type": "integer", "description": "type of share. 2 = Share embed", "example": 2 }, "applicationBinaryID": { "type": "string", "description": "ApplicationID where the share created", "example": "7dQDCuGxa86n6m7Ad" }, "linkID": { "type": "string", "description": "LinkID", "example": 455.128 }, "hasPassword": { "type": "boolean", "description": "The share is protected by password if hasPassword is true", "default": false }, "whiteLabel": { "type": "boolean", "description": "Enable white label if true", "default": false }, "hideTitle": { "type": "boolean", "description": "Hide title if true", "default": false }, "hideToolbar": { "type": "boolean", "description": "Hide toolbar if true", "default": false }, "autorun": { "type": "boolean", "description": "Launch automatically the app if autorun is true", "default": false }, "sharedAt": { "type": "string", "format": "date-time", "description": "Created date", "example": "2021-05-26T08:54:20.284Z" }, "status": { "type": "string", "description": "Status of the share.", "default": "active" }, "quota": { "$ref": "#/components/schemas/ShareQuota" }, "embedUrl": { "type": "string", "description": "embed url used to build your iframe", "example": "https://portal.furioos.com/embed/455.128" }, "iframe": { "type": "string", "description": "iframe example to embed in a html page", "example": "" } } }, "ShareSDK": { "type": "object", "properties": { "_id": { "type": "string", "description": "ID of the share", "example": "YYjrWfBER9thowoEM" }, "type": { "type": "integer", "description": "type of share. 3 = Share SDK", "example": 3 }, "applicationBinaryID": { "type": "string", "description": "ApplicationID where the share created", "example": "7dQDCuGxa86n6m7Ad" }, "websiteUrl": { "type": "string", "description": "Specify the URL of the website where Furioos SDK will be used (HTTPS required)", "example": "https://myWebsite.com" }, "linkID": { "type": "string", "description": "LinkID", "example": 455.128 }, "sharedAt": { "type": "string", "format": "date-time", "description": "Created date", "example": "2021-05-26T08:54:20.284Z" }, "hasPassword": { "type": "boolean", "description": "The share is protected by password if hasPassword is true", "default": false }, "status": { "type": "string", "description": "Status of the share.", "default": "active" }, "quota": { "$ref": "#/components/schemas/ShareQuota" } } }, "ShareQuota": { "type": "object", "properties": { "_id": { "type": "string", "description": "ID of the quota", "example": "FXuqgG8LDRZSwWezi" }, "shareID": { "type": "string", "description": "ID of the share", "example": "YYjrWfBER9thowoEM" }, "compute": { "type": "integer", "description": "Monthly usage quota (seconds)", "default": 3600 }, "usage": { "type": "object", "properties": { "compute": { "type": "integer", "description": "Duration of usage (seconds)", "example": 11446 } } }, "session": { "type": "object", "properties": { "maxDuration": { "type": "integer", "description": "Maximum session time (seconds)", "default": 600 } } }, "creatededAt": { "type": "string", "format": "date-time", "description": "Created date", "example": "2021-05-26T08:54:20.284Z" }, "refreshedAt": { "type": "string", "format": "date-time", "description": "Created date", "example": "2021-05-26T08:54:20.284Z" }, "status": { "type": "string", "description": "Status of the share.", "default": "active" } } }, "InputApplication": { "type": "object", "required": [ "name", "description", "mainExe", "thumbnail" ], "properties": { "name": { "type": "string", "description": "Name of the application", "default": "Name of my application" }, "description": { "type": "string", "description": "Description of the application", "default": "Description of the application" }, "mainExe": { "type": "string", "description": "Path of exe file", "example": "folder/myfile.exe" }, "thumbnail": { "type": "string", "format": "binary", "description": "Application thumbnail. Must be an image file" }, "quality": { "type": "integer", "description": "Quality type. Must be between 0 and 4.
0- 360p/30fps
1- 480p/30fps
2- 720p/30fps
3- 1080p/60fps -- default
4- Auto
" }, "computeTypeName": { "type": "string", "description": "Compute type name. The value must be :
-Standard -- default
-High
-Extreme
" }, "touchConvert": { "type": "boolean", "description": "Convert touch event to mouse event. false value by default" } } }, "InputShareLink": { "type": "object", "properties": { "autoRun": { "type": "boolean", "description": "Auto run the session", "default": false }, "password": { "type": "string", "description": "Password protection for your application" }, "compute": { "type": "integer", "description": "Monthly usage quota (seconds)", "example": 3600 }, "maxDuration": { "type": "integer", "description": "Maximum session time (seconds)", "example": 600 } } }, "InputShareEmbed": { "type": "object", "properties": { "autoRun": { "type": "boolean", "description": "Auto run the session", "default": false }, "whiteLabel": { "type": "boolean", "description": "Enable white label if true", "default": false }, "hideTitle": { "type": "boolean", "description": "Hide title if true", "default": false }, "hideToolbar": { "type": "boolean", "description": "Hide toolbar if true", "default": false }, "password": { "type": "string", "description": "Password protection for your application" }, "compute": { "type": "integer", "description": "Monthly usage quota (seconds)", "example": 3600 }, "maxDuration": { "type": "integer", "description": "Maximum session time (seconds)", "example": 600 } } }, "InputShareSDK": { "type": "object", "properties": { "compute": { "type": "integer", "description": "Monthly usage quota (seconds)", "example": 3600 }, "maxDuration": { "type": "integer", "description": "Maximum session time (seconds)", "example": 600 }, "websiteUrl": { "type": "string", "description": "Specify the URL of the website where Furioos SDK will be used (HTTPS required)", "example": "https://myWebsite.com" } } }, "response-error": { "type": "object", "properties": { "status": { "type": "integer", "description": "The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem." }, "message": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem." } } } } } } ```