{"id":78,"date":"2016-12-29T05:10:09","date_gmt":"2016-12-29T05:10:09","guid":{"rendered":"http:\/\/localhost\/sigmify\/resources\/?page_id=78"},"modified":"2020-03-30T11:38:35","modified_gmt":"2020-03-30T11:38:35","slug":"stream-api","status":"publish","type":"page","link":"https:\/\/sigmify.com\/resources\/stream-api\/","title":{"rendered":"Stream API"},"content":{"rendered":"<hr>\n<p>&nbsp;<\/p>\n<h3>Sigmify Stream API Document V0.1<\/h3>\n<p><strong>API Connectivity :<\/strong><\/p>\n<p>Sigmify exposes services via HTTPS on port 443. Clients must support SSLv2 with HIGH\u00a0strength<\/p>\n<p>cipher suites as defined by the current general release version of the Apache HTTP Server*.<br \/>\nClients should have an up-to-date CA Certificate registry supporting the \u201cVeriSign Class 3<br \/>\nSecure Server CA \u2013 G3\u201d signing certificate.<\/p>\n<p>*http:\/\/httpd.apache.org\/docs\/2.2\/mod\/mod_ssl.html#sslciphersuite<\/p>\n<p><strong>Encoding :<\/strong><\/p>\n<p>API requests and responses are encoded objects using the Javascript Object Notation (JSON)\u00a0syntax. Requests must include a valid JSON MIME type \u201ccontent type\u201d HTTP Header. JSON\u00a0responses will always include the \u2018application\/json\u2019 content-type.<\/p>\n<p><strong>Acceptable JSON MIME Types for HTTP Content-Type:<\/strong><\/p>\n<ul>\n<li>application\/json<\/li>\n<li>application\/x-javascript<\/li>\n<li>text\/javascript<\/li>\n<li>text\/x-javascript<\/li>\n<li>text\/x-json<\/li>\n<li>text\/json<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<p><strong>Note:<\/strong><\/p>\n<ol>\n<li>Objects with no properties may be denoted in JSON array syntax.<\/li>\n<li>Unless otherwise stated, null properties may be indicated with a JSON null or simply\u00a0omitted.<\/li>\n<li>JSON Object properties may appear in any order.<\/li>\n<li>JSON examples in this document are often formatted for visibility, but in practice\u00a0should contain minimum whitespace.<\/li>\n<li>Unless otherwise stated, all properties and values are case sensitive.<\/li>\n<li>If the HTTP request headers indicate compliance, the response body may optionally\u00a0be gzip or deflate encoded.<\/li>\n<li>The encoding will be indicated in the \u201cContentEncoding\u201d response header. All\u00a0requests should be encoded in Unicode UTF-8. Responses will be presented in Unicode UTF-8.<\/li>\n<\/ol>\n<p>&nbsp;<\/p>\n<p><strong>Authentication for Webservices :<\/strong><\/p>\n<p>Authentication token is expected with each API request. Client needs to call\u00a0<strong>getAuthToken\u00a0<\/strong>service to get a valid token which can then be used in subsequent requests. Token will\u00a0expire after 30 minutes.<\/p>\n<p>Every subsequent request needs to pass the token with attribute name \u201cauthToken\u201d.<\/p>\n<p>Login request requires user and password parameters passed using HTTP POST method.<\/p>\n<p><strong>Example:<\/strong><\/p>\n<p>Request:\u00a0https:\/\/www.sigmify.com\/getAuthToken?user=jDoe@xyz.com&amp;;password=pwd<\/p>\n<p>Response:<\/p>\n<p>{<\/p>\n<p>&#8220;message&#8221;: &#8220;OK&#8221;,<\/p>\n<p>&#8220;token&#8221;: &#8220;0b02008c-1a1c-46a0-a980-05f76b2a66ea&#8221;,<\/p>\n<p>&#8220;userCode&#8221;: &#8220;<span id=\"cloak1c969f1918bdc8ca4c6a606af9207cfd\"><a href=\"mailto:jDoe@xyz.com&quot;\">jDoe@xyz.com&#8221;<\/a><\/span>;,<\/p>\n<p>&#8220;firstName&#8221;: &#8220;John&#8221;,<\/p>\n<p>&#8220;lastName&#8221;: &#8220;Doe&#8221;<\/p>\n<p>}<\/p>\n<p>Error Response:<\/p>\n<p>{<\/p>\n<p>&#8220;message&#8221;: &#8220;Password is incorrect&#8221;,<\/p>\n<p>&#8220;userCode&#8221;: &#8220;<span id=\"cloak6454a62bf9d1d3dedde997aa85ba1176\"><a href=\"mailto:jDoe@xyz.com&quot;\">jDoe@xyz.com&#8221;<\/a><\/span>;<\/p>\n<p>}<\/p>\n<p>Client should make no more than 3 attempts to retry a failed authentication.<\/p>\n<p><strong>Webservices for updating Sigmify Stream<\/strong><\/p>\n<p>After getting the token using the\u00a0<strong>getAuthToken<\/strong>\u00a0service, the sigmify stream can be updated\u00a0using\u00a0<strong>updateSigmifyStream<\/strong>\u00a0API call.<\/p>\n<p>This is a post service.The token generated is sent as a parameter to this post and the data\u00a0to be updated is sent as a plain JSON string.<\/p>\n<p><strong>Example:<\/strong><\/p>\n<p>Request:<\/p>\n<p>https:\/\/www.sigmify.com\/updateSigmifyStream?authToken=&lt;generated token&gt;<\/p>\n<p>JSON format:<\/p>\n<p>{<\/p>\n<p>&#8220;origin&#8221;: &#8220;External&#8221;,<\/p>\n<p>&#8220;tenantId&#8221;: &#8220;XDFCGF&#8221;,<\/p>\n<p>&#8220;processName&#8221;: &#8220;Leave Process&#8221;,<\/p>\n<p>&#8220;processCode&#8221;: &#8220;CD001&#8221;,<\/p>\n<p>&#8220;tranxNo&#8221;: &#8220;TR00000001&#8221;,<\/p>\n<p>&#8220;messageId&#8221;: &#8220;MID000000001&#8221;,<\/p>\n<p>&#8220;messageStatus&#8221;: &#8220;P&#8221;,<\/p>\n<p>&#8220;messageDate&#8221;: &#8220;2015-03-14 15:20:36+05:30&#8221;,<\/p>\n<p>&#8220;documentName&#8221;: &#8220;Approve Leaave&#8221;,<\/p>\n<p>&#8220;docCode&#8221;: &#8220;DC00AT002&#8221;,<\/p>\n<p>&#8220;docCodePrev&#8221;: &#8221; DC00AT001&#8243;,<\/p>\n<p>&#8220;docNo&#8221;: &#8220;DN00001002&#8221;,<\/p>\n<p>&#8220;docNoPrev&#8221;: &#8221; DN00001001&#8243;,<\/p>\n<p>&#8220;subject1&#8221;: &#8220;employee name&#8221;,<\/p>\n<p>&#8220;subject2&#8221;: &#8220;2015-03-01 &#8220;,<\/p>\n<p>&#8220;subject3&#8221;: &#8220;Going out of station&#8221;,<\/p>\n<p>&#8220;subject4&#8221;: &#8220;10 Days&#8221;,<\/p>\n<p>&#8220;subject5&#8221;: &#8220;Approved by Supervisor&#8221;,<\/p>\n<p>&#8220;link&#8221;: &#8220;http:\/\/www.abc.com\/process\/openNexDocument?id=&#8221;,<\/p>\n<p>&#8220;attachmentExists&#8221;: &#8220;N&#8221;,<\/p>\n<p>&#8220;attachmentUrl&#8221;: &#8220;http:\/\/www.abc.com\/process\/attachment?id=&#8221;,<\/p>\n<p>&#8221; assignedToRoles&#8221;: &#8220;RoleCode1,RoleCode2&#8243;,<\/p>\n<p>&#8221; assignedToUsers&#8221;: &#8220;user_code1, user_code2,user_code3&#8221;,<\/p>\n<p>&#8220;completedBy&#8221;: &#8220;user_code1&#8221;,<\/p>\n<p>&#8220;completedDate&#8221;: &#8220;2015-03-16 15:20:36&#8221;<\/p>\n<p>}<\/p>\n<p>Response:<\/p>\n<p>{<\/p>\n<p>&#8220;status&#8221;: &#8220;OK&#8221;,<\/p>\n<p>&#8220;remarks&#8221;: &#8220;successfully updated&#8221;<\/p>\n<p>}<\/p>\n<p>Error Response:<\/p>\n<p>{<\/p>\n<p>&#8220;status&#8221;: &#8220;FAILED&#8221;,<\/p>\n<p>&#8220;remarks&#8221;: &#8220;unable to update record&#8221;<\/p>\n<p>}<\/p>\n<p><strong>Explanation of the JSON properties :<\/strong><\/p>\n<p>[table id=1 \/]<\/p>\n<p><strong>*The third party will need to send the user and roles that are valid in Sigmify.<\/strong>\t\t<\/p>\n","protected":false},"excerpt":{"rendered":"<p>&nbsp; Sigmify Stream API Document V0.1 API Connectivity : Sigmify exposes services via HTTPS on port 443. Clients must support SSLv2 with HIGH\u00a0strength cipher suites as defined by the current general release version of the Apache HTTP Server*. Clients should have an up-to-date CA Certificate registry supporting the \u201cVeriSign Class 3 Secure Server CA \u2013 [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"ocean_post_layout":"","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":"default","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":"default","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":"default","ocean_display_footer_bottom":"default","ocean_custom_footer_template":"","footnotes":""},"class_list":["post-78","page","type-page","status-publish","hentry","entry"],"_links":{"self":[{"href":"https:\/\/sigmify.com\/resources\/wp-json\/wp\/v2\/pages\/78","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sigmify.com\/resources\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/sigmify.com\/resources\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/sigmify.com\/resources\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/sigmify.com\/resources\/wp-json\/wp\/v2\/comments?post=78"}],"version-history":[{"count":2,"href":"https:\/\/sigmify.com\/resources\/wp-json\/wp\/v2\/pages\/78\/revisions"}],"predecessor-version":[{"id":6175,"href":"https:\/\/sigmify.com\/resources\/wp-json\/wp\/v2\/pages\/78\/revisions\/6175"}],"wp:attachment":[{"href":"https:\/\/sigmify.com\/resources\/wp-json\/wp\/v2\/media?parent=78"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}