{"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
\n\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

createWebApiSession<\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

Create a WebApi-Session.<\/p>

The maximum number of concurrent WepApiSessions per remote IP-Address is defined by the configuration parameter webapi.max.sessions.per.ip.<\/strong><\/em><\/p><\/div><\/div>

API version<\/h3>

1.0<\/p>

Working example URL: https:\/\/en.onlinedemo.picapport.de\/picapportapi\/1.0\/createWebApiSession<\/a><\/p>

Parameter<\/h3>
\u00a0<\/div>
apikey<\/td>string<\/td>7.4<\/td>depends on
webapi.apikey<\/strong><\/em>
parameter<\/td>

Only required if the webapi.apikey<\/strong><\/em> parameter is set in picapport.properties<\/em>.
It must be set to the same value as the webapi.apikey<\/strong><\/em> parameter.<\/p>

Only clients with a valid apikey<\/em> <\/strong>can access the webapi-functions.<\/p><\/td><\/tr><\/tbody><\/table><\/div>

Result<\/h3>
mime type<\/th>application\/json<\/td><\/tr><\/thead>
content<\/th>Session token to identify the current session
and public key to encrypt password.<\/td><\/tr>
http status codes<\/th>
  • 200 OK<\/li>
  • 400 Bad Request<\/li>
  • 403 Forbidden<\/li>
  • 404 Not Found<\/li>
  • 500 Internal Server Error<\/li>
  • 501 Not implemented<\/li><\/ul><\/td><\/tr><\/tbody><\/table><\/div>

    Result:JSON<\/h3>
    \u00a0<\/div>
    apisid<\/td>string<\/td>7.4<\/td>yes<\/td>

    WebAPI Session-ID required in some WebApi functions<\/p><\/td><\/tr>

    authorised<\/td>boolean<\/td>7.4<\/td>yes<\/td>

    true if session is already authorised.
    Configuration parameter webapi.default.uid<\/strong><\/em> has bee set to a valid userID.<\/p><\/td><\/tr>

    algorithm<\/td>string<\/td>7.4<\/td>yes<\/td>

    The following values are supported:<\/p>

    • none
      Only valid if the picapport.properties<\/em> parameter
      webapi.DISABLE.PASSWORD.ENCRYPTION=NoPwEncryptionForWebApi<\/em>
      is set.<\/li>
    • RSA
      This is the default.
      We currently support RSA-1024 (PKCS#1 v1.5 padding)<\/li><\/ul><\/td><\/tr>
    exponent<\/td>string<\/td>7.4<\/td>yes<\/td>Only provided if algorithm=RSA (required for client side password encryption)<\/td><\/tr>
    modulus<\/td>string<\/td>7.4<\/td>yes<\/td>Only provided if algorithm=RSA (required for client side password encryption)<\/td><\/tr><\/tbody><\/table>\t\t\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
    \n\t\t\t\t\t
    \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":"

    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. […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"ocean_front_end_style_editor":"no","ocean_post_layout":"full-screen","ocean_both_sidebars_style":"","ocean_both_sidebars_content_width":0,"ocean_both_sidebars_sidebars_width":0,"ocean_sidebar":"","ocean_second_sidebar":"","ocean_disable_margins":"enable","ocean_add_body_class":"","ocean_shortcode_before_top_bar":"","ocean_shortcode_after_top_bar":"","ocean_shortcode_before_header":"","ocean_shortcode_after_header":"","ocean_has_shortcode":"","ocean_shortcode_after_title":"","ocean_shortcode_before_footer_widgets":"","ocean_shortcode_after_footer_widgets":"","ocean_shortcode_before_footer_bottom":"","ocean_shortcode_after_footer_bottom":"","ocean_display_top_bar":"off","ocean_display_header":"default","ocean_header_style":"","ocean_center_header_left_menu":"","ocean_custom_header_template":"","ocean_custom_logo":0,"ocean_custom_retina_logo":0,"ocean_custom_logo_max_width":0,"ocean_custom_logo_tablet_max_width":0,"ocean_custom_logo_mobile_max_width":0,"ocean_custom_logo_max_height":0,"ocean_custom_logo_tablet_max_height":0,"ocean_custom_logo_mobile_max_height":0,"ocean_header_custom_menu":"","ocean_menu_typo_font_family":"","ocean_menu_typo_font_subset":"","ocean_menu_typo_font_size":0,"ocean_menu_typo_font_size_tablet":0,"ocean_menu_typo_font_size_mobile":0,"ocean_menu_typo_font_size_unit":"px","ocean_menu_typo_font_weight":"","ocean_menu_typo_font_weight_tablet":"","ocean_menu_typo_font_weight_mobile":"","ocean_menu_typo_transform":"","ocean_menu_typo_transform_tablet":"","ocean_menu_typo_transform_mobile":"","ocean_menu_typo_line_height":0,"ocean_menu_typo_line_height_tablet":0,"ocean_menu_typo_line_height_mobile":0,"ocean_menu_typo_line_height_unit":"","ocean_menu_typo_spacing":0,"ocean_menu_typo_spacing_tablet":0,"ocean_menu_typo_spacing_mobile":0,"ocean_menu_typo_spacing_unit":"","ocean_menu_link_color":"","ocean_menu_link_color_hover":"","ocean_menu_link_color_active":"","ocean_menu_link_background":"","ocean_menu_link_hover_background":"","ocean_menu_link_active_background":"","ocean_menu_social_links_bg":"","ocean_menu_social_hover_links_bg":"","ocean_menu_social_links_color":"","ocean_menu_social_hover_links_color":"","ocean_disable_title":"on","ocean_disable_heading":"default","ocean_post_title":"","ocean_post_subheading":"","ocean_post_title_style":"","ocean_post_title_background_color":"","ocean_post_title_background":0,"ocean_post_title_bg_image_position":"","ocean_post_title_bg_image_attachment":"","ocean_post_title_bg_image_repeat":"","ocean_post_title_bg_image_size":"","ocean_post_title_height":0,"ocean_post_title_bg_overlay":0.5,"ocean_post_title_bg_overlay_color":"","ocean_disable_breadcrumbs":"default","ocean_breadcrumbs_color":"","ocean_breadcrumbs_separator_color":"","ocean_breadcrumbs_links_color":"","ocean_breadcrumbs_links_hover_color":"","ocean_display_footer_widgets":"off","ocean_display_footer_bottom":"off","ocean_custom_footer_template":"","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}]}}