--- title: Licenças slug: pt/licencas docTags: createdAt: 2021-12-22T13:50:37.000Z --- :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.fsflt.net/customerarea/licenses/available", "name": "Get available licenses", "method": "GET", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "X-API-KEY", "type": "string", "description": "X-API-KEY" } ], "bodyDataParameters": [ { "kind": "required", "name": "customer_code", "type": "Number", "description": "Customer code" }, { "kind": "optional", "name": "lang", "type": "string", "description": "Language for the license name, defaults EN" }, { "kind": "optional", "name": "version_code", "type": "Number", "description": "Only search for version, defaults to all\nSee directory/licenses/versions for versions list" }, { "kind": "optional", "name": "license_duration", "type": "string", "description": "Search for duration (in monthes), Default: All durations" }, { "kind": "optional", "name": "license_code", "type": "string", "description": "Returns detail for specific license code" }, { "kind": "optional", "name": "currency_code", "type": "string", "description": "Currency for the license amount, default EUR\nSee directory/currencies for currencies list" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "fLq5yVk0nl9rycufct19a", "code": "{\n \"code\": 200,\n \"content\": [\n {\n \"license_code\": \"CL_Q_A005-M1\",\n \"license_name\": \"Business Filter License\",\n \"license_duration_months\": \"1\",\n \"license_version\": \"0\",\n \"license_quantity\": \"5 users\",\n \"license_points\": 0.5,\n \"license_amount\": 5,\n \"license_amount_currency\": \"EUR\"\n },\n {\n \"license_code\": \"CL_Q_A010-M1\",\n \"license_name\": \"Business Filter License\",\n \"license_duration_months\": \"1\",\n \"license_version\": \"0\",\n \"license_quantity\": \"10 users\",\n \"license_points\": 1,\n \"license_amount\": 10,\n \"license_amount_currency\": \"EUR€\"\n },\n ]\n}", "language": "200" }, { "id": "Jw0_RU4GAt6nlPBr8JKqm", "code": "{\n \"message\": \"Invalid token or Unauthorized admin\"\n}", "language": "401" }, { "id": "XivAqJMahHMwUZfqXRpdJ", "code": "{\r\n \"code\": 500,\r\n \"message\": \"The given data was invalid.\",\r\n \"errors\": {\r\n \"lang\": [\r\n \"The lang must be one of the following types: EN, IT, ES, DE\"\r\n ]\r\n }\r\n}", "language": "500" } ], "selectedLanguageId": "fLq5yVk0nl9rycufct19a" }, "examples": { "languages": [ { "id": "BnV038bZhTQOBdQl7MIRK", "code": "curl -X 'GET' \\\n 'https://api.fsflt.net/customerarea/licenses/availables' \\\n -H 'accept: application/json' \\\n -H \"Content-Type: application/json\" \\\n -H \"X-API-KEY: YOUR_API_KEY\" \\\n -d '{\"customer_code\": CUSTOMER_NUMBER, YOUR_PARAM}'", "language": "shell" } ], "selectedLanguageId": "BnV038bZhTQOBdQl7MIRK" }, "description": "Get available licenses for customer", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "get-available-licenses", "legacyHash": "K7sY0NblA7n1Cwp2OSbII" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://api.fsflt.net/customerarea/licenses/demo", "name": "Assign Demo", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "X-API-KEY", "type": "string", "description": "API Key for authorization" } ], "bodyDataParameters": [ { "kind": "required", "name": "customer_code", "type": "Number", "description": "Customer code" }, { "kind": "optional", "name": "lang", "type": "string", "description": "The language of the customer to whom the demo is assigned.\nDefault value => EN" }, { "kind": "optional", "name": "accept_notifications", "type": "Boolean", "description": "Flag allowing the user to choose whether or not to receive notifications when a new demo is assigned.\nDefault value => True" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "C7GpTguxewsR_1BeI0SDt", "code": "{\n \"code\": 200,\n \"content\": \n {\n \"customer\": \"FSDEV8080\",\n \"version\": \"CL_DEMO\",\n \"license\": \"Internet Protection and malware mitigation Trial - Demo inserted by API\",\n \"expiry_date\": \"2022-01-12\",\n \"license_id\": 108501\n }\n}", "language": "200" }, { "id": "1NlBINaoBD_5lMvAcVZqp", "code": "{\n \"message\": \"Invalid token or Unauthorized admin\"\n}", "language": "401" }, { "id": "4eVVs4P-Zita2aJJSGVWQ", "code": "{\r\n \"code\": 500,\r\n \"message\": \"The given data was invalid.\",\r\n \"errors\": {\r\n \"lang\": [\r\n \"The lang must be one of the following types: EN, IT, ES, DE\"\r\n ]\r\n }\r\n}", "language": "500" } ], "selectedLanguageId": "C7GpTguxewsR_1BeI0SDt" }, "examples": { "languages": [ { "id": "klVLF7Aq_5-FD6lq4PZ52", "code": "curl -X 'POST' \\\n 'https://api.fsflt.net/customerarea/licenses/demo' \\\n -H 'accept: application/json' \\\n -H \"Content-Type: application/json\" \\\n -H \"X-API-KEY: YOUR_API_KEY\" \\\n -d '{\"customer_code\": CUSTOMER_NUMBER, YOUR_PARAM}'", "language": "shell" } ], "selectedLanguageId": "klVLF7Aq_5-FD6lq4PZ52" }, "description": "Assigns a new demo license to the chosen customer", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "assign-demo", "legacyHash": "V1C4Sdozl99qUMbVa7AGp" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://api.fsflt.net/customerarea/licenses/assign", "name": "Assign License", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "optional", "name": "X-API-KEY", "type": "string", "description": "API Key for authorization" } ], "bodyDataParameters": [ { "kind": "required", "name": "customer_code", "type": "Number", "description": "Customer code" }, { "kind": "required", "name": "license_code", "type": "string", "description": "License code to be assigned\nSee licenses/available for licenses list\n" }, { "kind": "required", "name": "license_info", "type": "string", "description": "License description (ex. Headquarter, Secondary Office)" }, { "kind": "optional", "name": "accept_notifications", "type": "Boolean", "description": "Flag allowing the user to choose whether or not to receive notifications when a new license is assigned.\nDefault value => True" }, { "kind": "optional", "name": "currency_code", "type": "string", "description": "Currency for the deducted amount, default EUR\nSee directory/currencies for currencies list" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "GBujRodlRdisHXz7xJP43", "code": "{\n \"code\": 200,\n \"content\": {\n \"customer\": \"The customer name\",\n \"license_id\": \"13343\",\n \"start_date\": \"2022-01-18\",\n \"expiry_date\": \"2022-01-31\",\n \"deducted_amount\": 5,\n \"currency_code\": \"EUR\"\n }\n}", "language": "200" }, { "id": "ojLcmekP_Ieq4SQxJafHf", "code": "{\n \"message\": \"Invalid token or Unauthorized admin\"\n}", "language": "401" }, { "id": "jjqNz6PXxfGP6uI4YAnV2", "code": "{\r\n \"code\": 500,\r\n \"message\": \"The given data was invalid.\",\r\n \"errors\": {\r\n \"license_info\": [\r\n \"The license info may only contain letters, numbers, dashes and whitespace.\"\r\n ]\r\n }\r\n}", "language": "500" } ], "selectedLanguageId": "GBujRodlRdisHXz7xJP43" }, "examples": { "languages": [ { "id": "8pcr6WgXa0LOirYHoNgJu", "code": "curl -X 'POST' \\\n 'https://api.fsflt.net/licenses/assign' \\\n -H 'accept: application/json' \\\n -H \"Content-Type: application/json\" \\\n -H \"X-API-KEY: YOUR_API_KEY\" \\\n -d '{\"customer_code\": CUSTOMER_NUMBER, YOUR_PARAM}'", "language": "shell" } ], "selectedLanguageId": "8pcr6WgXa0LOirYHoNgJu" }, "description": "Assigns a new Bulk license to the chosen customer", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "assign-license", "legacyHash": "Xwn46s_2nVGv9P-DpqXg7" } ``` ::: :::ApiMethodV2 ```json { "tab": "request", "url": "https://api.fsflt.net/customerarea/licenses/suspend", "name": "Suspend license renewal", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "optional", "name": "X-API-KEY", "type": "string", "description": "" } ], "bodyDataParameters": [ { "kind": "required", "name": "license_id", "type": "string", "description": "ID of the license" }, { "kind": "required", "name": "customer_code", "type": "string", "description": "Customer code" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "hRXmDVs6b97S0_uaWnhxH", "code": "{\r\n \"code\": 200,\r\n \"content\": \"License suspended successfully.\"\r\n}", "language": "200", "customLabel": "" }, { "id": "EV-Yzpj5YvxWbPJuVX9f2", "code": "{\n \"code\": 405,\n \"message\": \"License already suspended.\",\n \"error\": []\n}", "language": "405", "customLabel": "" } ], "selectedLanguageId": "hRXmDVs6b97S0_uaWnhxH" }, "examples": { "languages": [ { "id": "W575XKnmsKRb-e-jUHMCE", "code": "curl -X 'POST' \\\r\n 'https://api.fsflt.net/customerarea/licenses/suspend' \\\r\n -H 'accept: application/json' \\\r\n -H \"Content-Type: application/json\" \\\r\n -H \"X-API-KEY: YOUR_API_KEY\" \\\r\n -d '{\"customer_code\": CUSTOMER_NUMBER, \"license_id\": LICENSE_ID}'", "language": "shell", "customLabel": "" } ], "selectedLanguageId": "W575XKnmsKRb-e-jUHMCE" }, "description": "", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "suspend-license-renewal", "legacyHash": "tY5F60EkALPqswPkEKvoy" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://api.fsflt.net/customerarea/licenses/enable", "name": "Resume license renewal", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "optional", "name": "X-API-KEY", "type": "string", "description": "" } ], "bodyDataParameters": [ { "kind": "required", "name": "license_id", "type": "string", "description": "ID of the license" }, { "kind": "required", "name": "customer_code", "type": "string", "description": "Customer code" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "hRXmDVs6b97S0_uaWnhxH", "code": "{\r\n \"code\": 200,\r\n \"content\": \"License enabled successfully.\"\r\n}", "language": "200", "customLabel": "" }, { "id": "EV-Yzpj5YvxWbPJuVX9f2", "code": "{\n \"code\": 405,\n \"message\": \"License already suspended.\",\n \"error\": []\n}", "language": "405", "customLabel": "" } ], "selectedLanguageId": "hRXmDVs6b97S0_uaWnhxH" }, "examples": { "languages": [ { "id": "SbXXIMynN_OOyzpAD5gOZ", "code": "curl -X 'POST' \\\r\n 'https://api.fsflt.net/customerarea/licenses/enable' \\\r\n -H 'accept: application/json' \\\r\n -H \"Content-Type: application/json\" \\\r\n -H \"X-API-KEY: YOUR_API_KEY\" \\\r\n -d '{\"customer_code\": CUSTOMER_NUMBER, \"license_id\": LICENSE_ID}'", "language": "shell", "customLabel": "" } ], "selectedLanguageId": "SbXXIMynN_OOyzpAD5gOZ" }, "description": "", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "resume-license-renewal", "legacyHash": "b26cKcOT3UabAHlEyK0-K" } ``` :::