{"id":1334,"date":"2024-03-13T11:11:25","date_gmt":"2024-03-13T10:11:25","guid":{"rendered":"https:\/\/contecon.de\/picapportwiki\/?page_id=1334"},"modified":"2024-03-13T11:11:58","modified_gmt":"2024-03-13T10:11:58","slug":"createwebapisession","status":"publish","type":"page","link":"https:\/\/contecon.de\/picapportwiki\/createwebapisession\/","title":{"rendered":"createWebApiSession"},"content":{"rendered":"\t\t<div data-elementor-type=\"wp-page\" data-elementor-id=\"1334\" class=\"elementor elementor-1334\">\n\t\t\t\t<div class=\"elementor-element elementor-element-b0f5c54 e-flex e-con-boxed e-con e-parent\" data-id=\"b0f5c54\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\" data-core-v316-plus=\"true\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-56896d7 elementor-widget elementor-widget-heading\" data-id=\"56896d7\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.19.0 - 07-02-2024 *\/\n.elementor-heading-title{padding:0;margin:0;line-height:1}.elementor-widget-heading .elementor-heading-title[class*=elementor-size-]>a{color:inherit;font-size:inherit;line-height:inherit}.elementor-widget-heading .elementor-heading-title.elementor-size-small{font-size:15px}.elementor-widget-heading .elementor-heading-title.elementor-size-medium{font-size:19px}.elementor-widget-heading .elementor-heading-title.elementor-size-large{font-size:29px}.elementor-widget-heading .elementor-heading-title.elementor-size-xl{font-size:39px}.elementor-widget-heading .elementor-heading-title.elementor-size-xxl{font-size:59px}<\/style><h2 class=\"elementor-heading-title elementor-size-default\">createWebApiSession<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-0ad8c22 elementor-widget elementor-widget-text-editor\" data-id=\"0ad8c22\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.19.0 - 07-02-2024 *\/\n.elementor-widget-text-editor.elementor-drop-cap-view-stacked .elementor-drop-cap{background-color:#69727d;color:#fff}.elementor-widget-text-editor.elementor-drop-cap-view-framed .elementor-drop-cap{color:#69727d;border:3px solid;background-color:transparent}.elementor-widget-text-editor:not(.elementor-drop-cap-view-default) .elementor-drop-cap{margin-top:8px}.elementor-widget-text-editor:not(.elementor-drop-cap-view-default) .elementor-drop-cap-letter{width:1em;height:1em}.elementor-widget-text-editor .elementor-drop-cap{float:left;text-align:center;line-height:1;font-size:50px}.elementor-widget-text-editor .elementor-drop-cap-letter{display:inline-block}<\/style>\t\t\t\t<p>Create a WebApi-Session.<\/p><div class=\"confluence-information-macro confluence-information-macro-information conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"info\"><div class=\"confluence-information-macro-body\"><p>The maximum number of concurrent WepApiSessions per remote IP-Address is defined by the configuration parameter <em><strong>webapi.max.sessions.per.ip.<\/strong><\/em><\/p><\/div><\/div><h3 id=\"createWebApiSession-APIversion\">API version<\/h3><p>1.0<\/p><p>Working example URL: <a class=\"external-link\" href=\"https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/createWebApiSession\" rel=\"nofollow\">https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/createWebApiSession<\/a><\/p><h3 id=\"createWebApiSession-Parameter\">Parameter<\/h3><div class=\"table-wrap\">\u00a0<\/div><div class=\"table-wrap\"><table class=\"confluenceTable tablesorter tablesorter-default stickyTableHeaders\" role=\"grid\"><tbody aria-live=\"polite\" aria-relevant=\"all\"><tr role=\"row\"><td class=\"confluenceTd\">apikey<\/td><td class=\"confluenceTd\">string<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">depends on<br \/><em><strong>webapi.apikey<\/strong><\/em><br \/>parameter<\/td><td class=\"confluenceTd\"><p>Only required if the <em><strong>webapi.apikey<\/strong><\/em> parameter is set in <em>picapport.properties<\/em>.<br \/>It must be set to the same value as the <em><strong>webapi.apikey<\/strong><\/em> parameter.<\/p><p>Only clients with a valid <strong><em>apikey<\/em> <\/strong>can access the webapi-functions.<\/p><\/td><\/tr><\/tbody><\/table><\/div><h3 id=\"createWebApiSession-Result\">Result<\/h3><div class=\"table-wrap\"><table class=\"confluenceTable\"><thead><tr><th class=\"confluenceTh\">mime type<\/th><td class=\"confluenceTd\">application\/json<\/td><\/tr><\/thead><tbody><tr><th class=\"confluenceTh\">content<\/th><td class=\"confluenceTd\">Session token to identify the current session<br \/>and public key to encrypt password.<\/td><\/tr><tr><th class=\"confluenceTh\" colspan=\"1\">http status codes<\/th><td class=\"confluenceTd\" colspan=\"1\"><ul><li>200 OK<\/li><li>400 Bad Request<\/li><li>403 Forbidden<\/li><li>404 Not Found<\/li><li>500 Internal Server Error<\/li><li>501 Not implemented<\/li><\/ul><\/td><\/tr><\/tbody><\/table><\/div><h3 id=\"createWebApiSession-Result:JSON\">Result:JSON<\/h3><div class=\"table-wrap\">\u00a0<\/div><table class=\"confluenceTable tablesorter tablesorter-default stickyTableHeaders\" role=\"grid\"><tbody aria-live=\"polite\" aria-relevant=\"all\"><tr role=\"row\"><td class=\"confluenceTd\">apisid<\/td><td class=\"confluenceTd\">string<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">yes<\/td><td class=\"confluenceTd\"><p>WebAPI Session-ID required in some WebApi functions<\/p><\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\">authorised<\/td><td class=\"confluenceTd\">boolean<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">yes<\/td><td class=\"confluenceTd\"><p>true if session is already authorised.<br \/>Configuration parameter <em><strong>webapi.default.uid<\/strong><\/em> has bee set to a valid userID.<\/p><\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\" colspan=\"1\">algorithm<\/td><td class=\"confluenceTd\" colspan=\"1\">string<\/td><td class=\"confluenceTd\" colspan=\"1\">7.4<\/td><td class=\"confluenceTd\" colspan=\"1\">yes<\/td><td class=\"confluenceTd\" colspan=\"1\"><p>The following values are supported:<\/p><ul><li>none<br \/>Only valid if the <em>picapport.properties<\/em> parameter <br \/><em>webapi.DISABLE.PASSWORD.ENCRYPTION=NoPwEncryptionForWebApi<\/em><br \/>is set.<\/li><li>RSA <br \/>This is the default.<br \/>We currently support RSA-1024 (PKCS#1 v1.5 padding)<\/li><\/ul><\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\" colspan=\"1\">exponent<\/td><td class=\"confluenceTd\" colspan=\"1\">string<\/td><td class=\"confluenceTd\" colspan=\"1\">7.4<\/td><td class=\"confluenceTd\" colspan=\"1\">yes<\/td><td class=\"confluenceTd\" colspan=\"1\">Only provided if algorithm=RSA (required for client side password encryption)<\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\" colspan=\"1\">modulus<\/td><td class=\"confluenceTd\" colspan=\"1\">string<\/td><td class=\"confluenceTd\" colspan=\"1\">7.4<\/td><td class=\"confluenceTd\" colspan=\"1\">yes<\/td><td class=\"confluenceTd\" colspan=\"1\">Only provided if algorithm=RSA (required for client side password encryption)<\/td><\/tr><\/tbody><\/table>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-8ead214 e-flex e-con-boxed e-con e-parent\" data-id=\"8ead214\" data-element_type=\"container\" data-settings=\"{&quot;content_width&quot;:&quot;boxed&quot;}\" data-core-v316-plus=\"true\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"<p>createWebApiSession Create a WebApi-Session. The maximum number of concurrent WepApiSessions per remote IP-Address is defined by the configuration parameter webapi.max.sessions.per.ip. API version 1.0 Working example URL: https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/createWebApiSession Parameter \u00a0 apikey string 7.4 depends onwebapi.apikeyparameter Only required if the webapi.apikey parameter is set in picapport.properties.It must be set to the same value as the webapi.apikey parameter. [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-1334","page","type-page","status-publish","hentry","entry"],"_links":{"self":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1334","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/comments?post=1334"}],"version-history":[{"count":4,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1334\/revisions"}],"predecessor-version":[{"id":1338,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1334\/revisions\/1338"}],"wp:attachment":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/media?parent=1334"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}