{"id":1307,"date":"2024-03-13T10:58:47","date_gmt":"2024-03-13T09:58:47","guid":{"rendered":"https:\/\/contecon.de\/picapportwiki\/?page_id=1307"},"modified":"2024-05-28T11:04:35","modified_gmt":"2024-05-28T09:04:35","slug":"picapport-web-api-2","status":"publish","type":"page","link":"https:\/\/contecon.de\/picapportwiki\/picapport-web-api-2\/","title":{"rendered":"PicApport Web-API"},"content":{"rendered":"\t\t<div data-elementor-type=\"wp-page\" data-elementor-id=\"1307\" class=\"elementor elementor-1307\">\n\t\t\t\t<div class=\"elementor-element elementor-element-fb47c83 e-flex e-con-boxed e-con e-parent\" data-id=\"fb47c83\" 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-0781a71 elementor-widget elementor-widget-heading\" data-id=\"0781a71\" 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\">PicApport Web-API<\/h2>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-5e01a05 elementor-widget elementor-widget-heading\" data-id=\"5e01a05\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">Features<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-54ead23 elementor-widget elementor-widget-text-editor\" data-id=\"54ead23\" 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>The PicApport Web API has been introduced in PicApport Version 7.4<\/p><p>For an example Gallery built with the WebAPI click on the following link: <a class=\"external-link\" href=\"https:\/\/en.onlinedemo.picapport.de\/public\/sharedgalleries.html\" rel=\"nofollow\">https:\/\/en.onlinedemo.picapport.de\/public\/sharedgalleries.html<\/a><\/p><p>The following features are supported:<\/p><ul><li>Easy access to photos and their metadata stored in PicApport<br \/><br \/><\/li><li>An function to upload photos to PicApport with setting of metadata like title, tags, description etc&#8230;<br \/><br \/><\/li><li>Photos can be dynamically scaled<br \/><br \/><\/li><li>Supports all operators and functions of PicApports built-in photo query language:\u00a0 <a class=\"external-link\" href=\"https:\/\/en.onlinedemo.picapport.de\/picapport#help\" rel=\"nofollow\">https:\/\/en.onlinedemo.picapport.de\/picapport#help<\/a><br \/><br \/><\/li><li>Session and user permission functions are supported including role based photo filtering<\/li><\/ul>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-9ceecd1 elementor-widget elementor-widget-heading\" data-id=\"9ceecd1\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">Getting started<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-6d60d14 elementor-widget elementor-widget-text-editor\" data-id=\"6d60d14\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>To get the WebApi up and running we recommend to start with the following configuration parameters in picapport.properties and restart the server:<\/p><div class=\"code panel pdl conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"code\"><div class=\"codeContent panelContent pdl\"><div><div id=\"highlighter_620899\" class=\"syntaxhighlighter sh-confluence nogutter  text\"><table border=\"0\" cellspacing=\"0\" cellpadding=\"0\"><tbody><tr><td class=\"code\"><div class=\"container\" title=\"Hint: double-click to select code\"><div class=\"line number1 index0 alt2\"><code class=\"text plain\">webapi.enabled=true<\/code><\/div><div class=\"line number2 index1 alt1\"><code class=\"text plain\">webapi.testpageenabled=true<\/code><\/div><div class=\"line number3 index2 alt2\"><code class=\"text plain\">webapi.has.public.content=true<\/code><\/div><div class=\"line number4 index3 alt1\"><code class=\"text plain\">#the following will work only if a user picapport exists with password picapport (public user)<\/code><\/div><div class=\"line number5 index4 alt2\"><code class=\"text plain\">webapi.default.uid=picapport<\/code><\/div><\/div><\/td><\/tr><\/tbody><\/table><\/div><\/div><\/div><\/div><p>\u00a0<\/p><p>If everything is configured properly you should see the following in PicApport About-Page (click on the image to enlarge):<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-47645af elementor-widget elementor-widget-image\" data-id=\"47645af\" data-element_type=\"widget\" data-widget_type=\"image.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-image{text-align:center}.elementor-widget-image a{display:inline-block}.elementor-widget-image a img[src$=\".svg\"]{width:48px}.elementor-widget-image img{vertical-align:middle;display:inline-block}<\/style>\t\t\t\t\t\t\t\t\t\t<img fetchpriority=\"high\" decoding=\"async\" width=\"813\" height=\"717\" src=\"https:\/\/contecon.de\/picapportwiki\/wp-content\/uploads\/2024\/03\/PicApportWebApiAboutPage.jpg\" class=\"attachment-large size-large wp-image-1309\" alt=\"\" srcset=\"https:\/\/contecon.de\/picapportwiki\/wp-content\/uploads\/2024\/03\/PicApportWebApiAboutPage.jpg 813w, https:\/\/contecon.de\/picapportwiki\/wp-content\/uploads\/2024\/03\/PicApportWebApiAboutPage-300x265.jpg 300w, https:\/\/contecon.de\/picapportwiki\/wp-content\/uploads\/2024\/03\/PicApportWebApiAboutPage-768x677.jpg 768w\" sizes=\"(max-width: 813px) 100vw, 813px\" \/>\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-2bfcae8 elementor-widget elementor-widget-heading\" data-id=\"2bfcae8\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">URL Scheme<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-253e14c elementor-widget elementor-widget-text-editor\" data-id=\"253e14c\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>[protocoll:\/\/picapportserveraddress]\/picapportapi\/version\/<strong><em>function<\/em><\/strong>?parameter<\/p><p>Click on the following example URL to see it working: <a class=\"external-link\" href=\"https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getSharedGallerys\" rel=\"nofollow\">https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/getSharedGallerys<\/a><em><strong>\u00a0<\/strong><\/em><\/p>\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-dd3e341 e-flex e-con-boxed e-con e-parent\" data-id=\"dd3e341\" 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-839a46d elementor-widget elementor-widget-heading\" data-id=\"839a46d\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">Web-interface for tests and examples<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-33f027d elementor-widget elementor-widget-text-editor\" data-id=\"33f027d\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>PicApport provides an optional Web-interface that can be used to test and play with the API in your own environment: (Or on our Demo: <a class=\"external-link\" href=\"https:\/\/en.onlinedemo.picapport.de\/picapport-webapitest.html\" rel=\"nofollow\">https:\/\/en.onlinedemo.picapport.de\/picapport-webapitest.html<\/a>)<\/p><p>Click on the image below to see how it works.<\/p>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-ba58b36 elementor-widget elementor-widget-image\" data-id=\"ba58b36\" data-element_type=\"widget\" data-widget_type=\"image.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t<img decoding=\"async\" width=\"1024\" height=\"724\" src=\"https:\/\/contecon.de\/picapportwiki\/wp-content\/uploads\/2024\/03\/PicApportWebApiScreenshot-1024x724.jpg\" class=\"attachment-large size-large wp-image-1310\" alt=\"\" srcset=\"https:\/\/contecon.de\/picapportwiki\/wp-content\/uploads\/2024\/03\/PicApportWebApiScreenshot-1024x724.jpg 1024w, https:\/\/contecon.de\/picapportwiki\/wp-content\/uploads\/2024\/03\/PicApportWebApiScreenshot-300x212.jpg 300w, https:\/\/contecon.de\/picapportwiki\/wp-content\/uploads\/2024\/03\/PicApportWebApiScreenshot-768x543.jpg 768w, https:\/\/contecon.de\/picapportwiki\/wp-content\/uploads\/2024\/03\/PicApportWebApiScreenshot-1536x1086.jpg 1536w, https:\/\/contecon.de\/picapportwiki\/wp-content\/uploads\/2024\/03\/PicApportWebApiScreenshot.jpg 1698w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/>\t\t\t\t\t\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-4c95613 elementor-widget elementor-widget-heading\" data-id=\"4c95613\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">Sample Workflows<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-2441b08 elementor-widget elementor-widget-text-editor\" data-id=\"2441b08\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<h3 id=\"PicApportWeb-API-WorkwithsharedPhotos\">Work with shared Photos<\/h3><ul><li>See the sourcecode of our example on <a class=\"external-link\" href=\"https:\/\/en.onlinedemo.picapport.de\/public\/sharedgalleries.html\" rel=\"nofollow\">https:\/\/en.onlinedemo.picapport.de\/public\/sharedgalleries.html<\/a><br \/>Download the example file and copy it to your <em><strong>.picapport\/public<\/strong><\/em> directory and change it to your demands.<br \/>(make sure that configuration parameter <strong><em>webapi.has.public.content=true<\/em><\/strong> has been set first).<\/li><\/ul><h3 id=\"PicApportWeb-API-RunaQueryagainstPicApportsphotodatabase\">Run a Query against PicApports photo database<\/h3><ol><li>call <a href=\"https:\/\/contecon.de\/picapportwiki\/createwebapisession\/\">createWebApiSession<\/a> to get a valid <em><strong>apisid <\/strong><\/em>(API session ID)<\/li><li>dependent on your configuration it may be required to call <a href=\"https:\/\/contecon.de\/picapportwiki\/authorizewebapisession\/\">authorizeWebApiSession<\/a> with userid and password to authorize your session<\/li><li>call <a href=\"https:\/\/contecon.de\/picapportwiki\/runquery\/\">runQuery<\/a> to execute you query and get a <em><strong>vid<\/strong> <\/em>(viewID) and number of photos in the result<\/li><li>call <a href=\"https:\/\/contecon.de\/picapportwiki\/getphoto\/\">getPhoto<\/a>, <a href=\"https:\/\/contecon.de\/picapportwiki\/getphotometadata\/\">getPhotoMetadata<\/a>, <a href=\"https:\/\/contecon.de\/picapportwiki\/getthumbnail\/\">getThumbnail,<\/a> <a href=\"https:\/\/contecon.de\/picapportwiki\/getoriginalfile\/\">getOriginalFile<\/a>, with <em><strong>apisid<\/strong><\/em>, <em><strong>vid<\/strong> <\/em>and zero based <em><strong>index<\/strong> <\/em>to access the photos and metadata.<\/li><\/ol><h3 id=\"PicApportWeb-API-Uploadphotos\">Upload photos<\/h3><ol><li>call <a href=\"https:\/\/contecon.de\/picapportwiki\/createwebapisession\/\">createWebApiSession<\/a> to get a valid <em><strong>apisid<\/strong><\/em><\/li><li>dependent on your configuration it may be required to call <a href=\"https:\/\/contecon.de\/picapportwiki\/authorizewebapisession\/\">authorizeWebApiSession<\/a> with userid and password to authorize your session<\/li><li>call <a href=\"https:\/\/contecon.de\/picapportwiki\/upload\/\">upload<\/a> to upload photos with metadata<\/li><\/ol>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-84a63c0 elementor-widget elementor-widget-heading\" data-id=\"84a63c0\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">Documentation of available functions<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-1e8ba03 elementor-widget elementor-widget-text-editor\" data-id=\"1e8ba03\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<ul class=\"childpages-macro conf-macro output-block\" data-hasbody=\"false\" data-macro-name=\"children\"><li><a href=\"https:\/\/contecon.de\/picapportwiki\/authorizewebapisession\/\">authorizeWebApiSession<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/checkuserpermission\/\">checkUserPermission<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/checkphotoid\/\">checkPhotoId<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/closewebapisession\/\">closeWebApiSession<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/createwebapisession\/\">createWebApiSession<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/getgallery\/\">getGallery<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/getoriginalfile\/\">getOriginalFile<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/getphoto\/\">getPhoto<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/getphotometadata\/\">getPhotoMetadata<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/getserverstatus\/\">getServerStatus<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/getsharedgallerys\/\">getSharedGallerys<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/getthumbnail\/\">getThumbnail<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/removephoto\/\">removePhoto<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/runquery\/\">runQuery<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/upload\/\">upload<\/a><\/li><li><a href=\"https:\/\/contecon.de\/picapportwiki\/url-parameter-to-identify-a-photo\/\">URL Parameter to identify a photo<\/a><\/li><\/ul>\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-9a2ae37 elementor-widget elementor-widget-heading\" data-id=\"9a2ae37\" data-element_type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<h3 class=\"elementor-heading-title elementor-size-default\">Configuration parameter to control Web-API functions in picapport.properties<\/h3>\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-a3c7feb elementor-widget elementor-widget-text-editor\" data-id=\"a3c7feb\" data-element_type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t<p>For a general description of the picapport.properties see: <a href=\"https:\/\/contecon.de\/picapportwiki\/picapport-server-guide-2\/\">PicApport-Server Guide<\/a><\/p><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\">webapi.enabled<\/td><td class=\"confluenceTd\">not set (false)<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">YES<\/td><td class=\"confluenceTd\">This parameter must be set to <em><strong>true<\/strong><\/em> to activate the Web-Api<\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\" colspan=\"1\">webapi.testpageenabled<\/td><td class=\"confluenceTd\" colspan=\"1\">not set (true if webapi.enabled)<\/td><td class=\"confluenceTd\" colspan=\"1\">7.4<\/td><td class=\"confluenceTd\" colspan=\"1\">YES<\/td><td class=\"confluenceTd\" colspan=\"1\"><p>If this parameter is set to false the WebApi-Testpage <em><strong>[http:toServer]\/picapport-webapitest.html<\/strong><\/em> will not<br \/>be available on the PicApport server.<\/p><\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\" colspan=\"1\">webapi.has.public.content<\/td><td class=\"confluenceTd\" colspan=\"1\">not set (false)<\/td><td class=\"confluenceTd\" colspan=\"1\">7.4<\/td><td class=\"confluenceTd\" colspan=\"1\">YES<\/td><td class=\"confluenceTd\" colspan=\"1\">This parameter must be set to <em><strong>true<\/strong><\/em> to activate the delivery of content in the <em><strong>.picapport\/public<\/strong><\/em> directory.<br \/>This can be used to create your own html-files using the Web-Api to create stylish galleys etc.<\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\" colspan=\"1\">webapi.public.dir.allowed<\/td><td class=\"confluenceTd\" colspan=\"1\">not set (true if webapi.has.public.content)<\/td><td class=\"confluenceTd\" colspan=\"1\">7.4<\/td><td class=\"confluenceTd\" colspan=\"1\">YES<\/td><td class=\"confluenceTd\" colspan=\"1\"><p>If this parameter is set to true (default) the the content of the <em><strong>.picapport\/public<\/strong><\/em> directory can be queried by just entering <br \/>the URL <em><strong>[YourPicapportServerAdress]\/public<\/strong><\/em><\/p><p>This is only relevant if<strong>\u00a0webapi.has.public.content<\/strong> is set to true.<strong><em><br \/><\/em><\/strong><\/p><\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\">webapi.functions<\/td><td class=\"confluenceTd\">not set (empty)<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">YES<\/td><td class=\"confluenceTd\"><p>Optional comma separated list of functions that should be available for the web-api.<br \/>If this parameter is not defined all functions will be available.<\/p><p>Example to just support access to shared gallery&#8217;s:<\/p><ul><li>webapi.functions=getSharedGallerys,getGallery,getPhotoMetadata,getPhoto<\/li><\/ul><\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\">webapi.apikey<\/td><td class=\"confluenceTd\">not set (empty)<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">YES<\/td><td class=\"confluenceTd\">Optional parameter to define a key that must be set to call the createWebApiSession<\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\" colspan=\"1\">webapi.default.uid<\/td><td class=\"confluenceTd\" colspan=\"1\">not set (empty)<\/td><td class=\"confluenceTd\" colspan=\"1\">7.4<\/td><td class=\"confluenceTd\" colspan=\"1\">YES<\/td><td class=\"confluenceTd\" colspan=\"1\"><p>Optional parameter to set a UserID used for the WebAPI session. (technical user)<\/p><p>If set and the uid exists a call to createWebApiSession automaticaly creates <br \/>a WebAPI session for this user. In this case a call to authorizeWebApiSession is not required.<\/p><p><u><em><strong>Important:<\/strong><\/em><\/u> <strong><em>userId<\/em> <\/strong><em>and <strong>password <\/strong><\/em>for the user used as <em><strong>webapi.default.uid<\/strong><\/em> must be identical!<\/p><\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\">webapi.session.timeout.seconds<\/td><td class=\"confluenceTd\">not set (default = 30 * 60 seconds<br \/>\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 = 30 minutes)<\/td><td class=\"confluenceTd\">7.4<\/td><td class=\"confluenceTd\">YES<\/td><td class=\"confluenceTd\"><p>Time until a web-api session on the server will be terminated if no activity detected.<\/p><p>A value of at least 60 seconds must be set<\/p><\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\" colspan=\"1\">webapi.max.sessions.per.ip<\/td><td class=\"confluenceTd\" colspan=\"1\">not set (default=20)<\/td><td class=\"confluenceTd\" colspan=\"1\">7.4<\/td><td class=\"confluenceTd\" colspan=\"1\">YES<\/td><td class=\"confluenceTd\" colspan=\"1\"><p>Maximum number of concurrent open sessions per remote IP-address. It is recommended<br \/>to use closeWepApiSession if a session is not required anymore.<\/p><p>A value of at least 1 seconds must be set<\/p><\/td><\/tr><tr role=\"row\"><td class=\"confluenceTd\" colspan=\"1\">webapi.DISABLE.PASSWORD.ENCRYPTION<\/td><td class=\"confluenceTd\" colspan=\"1\">not set (false)<\/td><td class=\"confluenceTd\" colspan=\"1\">7.4<\/td><td class=\"confluenceTd\" colspan=\"1\">YES<\/td><td class=\"confluenceTd\" colspan=\"1\"><div class=\"confluence-information-macro confluence-information-macro-warning conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"warning\"><p class=\"title\">Use with care<\/p><div class=\"confluence-information-macro-body\"><p>Optional. Use only for testing in secure networks.<\/p><p>If set to <em><strong>NoPwEncryptionForWebApi<\/strong><\/em> then unencryped passwords will be<br \/>accepted by the <em>authorizeWebApiSession<\/em> function.<\/p><\/div><\/div><\/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-5038373 e-flex e-con-boxed e-con e-parent\" data-id=\"5038373\" 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>PicApport Web-API Features The PicApport Web API has been introduced in PicApport Version 7.4 For an example Gallery built with the WebAPI click on the following link: https:\/\/en.onlinedemo.picapport.de\/public\/sharedgalleries.html The following features are supported: Easy access to photos and their metadata stored in PicApport An function to upload photos to PicApport with setting of metadata like [&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-1307","page","type-page","status-publish","hentry","entry"],"_links":{"self":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1307","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=1307"}],"version-history":[{"count":9,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1307\/revisions"}],"predecessor-version":[{"id":2385,"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/pages\/1307\/revisions\/2385"}],"wp:attachment":[{"href":"https:\/\/contecon.de\/picapportwiki\/wp-json\/wp\/v2\/media?parent=1307"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}