mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-08 02:37:40 +02:00
1 line
8.7 KiB
JavaScript
1 line
8.7 KiB
JavaScript
(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[5794],{13897(e,t,n){"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>p,default:()=>f,frontMatter:()=>d,metadata:()=>o,toc:()=>h});const o=JSON.parse('{"id":"API-docs/v1/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","source":"@site/docs/API-docs/v1/opensign-api-v-1.info.mdx","sourceDirName":"API-docs/v1","slug":"/API-docs/v1/opensign-api-v-1","permalink":"/docs/API-docs/v1/opensign-api-v-1","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"v1","permalink":"/docs/API-docs/v1"},"next":{"title":"Get your account details","permalink":"/docs/API-docs/v1/get-user"}}');var i=n(74848),s=n(28453),a=(n(43905),n(51107)),r=n(23397),l=n.n(r),c=n(19365);n(69016);const d={id:"opensign-api-v-1",title:"OpenSign API v1",description:"Welcome to the OpenSign\u2122 API documentation!",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},p=void 0,u={},h=[];function m(e){const t={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,i.jsx)(a.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1"}),"\n",(0,i.jsx)(t.p,{children:"Welcome to the OpenSign\u2122 API documentation!"}),"\n",(0,i.jsx)(t.p,{children:"Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign\u2122 delivers robust solutions tailored to your needs."}),"\n",(0,i.jsx)(t.p,{children:"Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign\u2122 and transform your digital document processes."}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Useful Links:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate x-api-token"})," \u2013 Learn how to securely generate and manage your API token for authenticating requests."]}),"\n"]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,i.jsx)(a.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,i.jsx)(l(),{className:"openapi-tabs__security-schemes",children:(0,i.jsx)(c.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,i.jsx)("div",{children:(0,i.jsx)("table",{children:(0,i.jsxs)("tbody",{children:[(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"apiKey"})})]}),(0,i.jsxs)("tr",{children:[(0,i.jsx)("th",{children:(0,i.jsx)(t.p,{children:"Header parameter name:"})}),(0,i.jsx)("td",{children:(0,i.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,i.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"Contact"})}),(0,i.jsx)("span",{children:(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"Terms of Service"})}),(0,i.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,i.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,i.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,i.jsx)(t.p,{children:"License"})}),(0,i.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,i.jsx)(t.p,{children:"AGPL v 3.0"})})]})]})}function f(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(m,{...e})}):m(e)}},69016(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const i=o(n(96540)),s=o(n(4213));t.default=function({url:e,proxy:t}){return i.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},i.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),i.default.createElement("ul",{className:"export-dropdown dropdown__menu"},i.default.createElement("li",null,i.default.createElement("a",{onClick:t=>{t.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),s.default.saveAs(e,t||"openapi.txt")})(`${e}`)},className:"dropdown__link",href:`${e}`},"OpenAPI Spec"))))}},43905(e,t,n){"use strict";var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e){const{colorMode:t}=(0,s.useColorMode)(),{logo:n,darkLogo:o}=e,l=()=>"dark"===t?o?.altText??n?.altText:n?.altText,c=(0,a.default)(n?.url),d=(0,a.default)(o?.url);if(n&&o)return i.default.createElement(r.default,{alt:l(),sources:{light:c,dark:d},className:"openapi__logo"});if(n||o)return i.default.createElement(r.default,{alt:l(),sources:{light:c??d,dark:c??d},className:"openapi__logo"});return};const i=o(n(96540)),s=n(83262),a=o(n(86025)),r=o(n(15626))},4213(e,t){var n,o,i;o=[],void 0===(i="function"==typeof(n=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(console.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function n(e,t,n){var o=new XMLHttpRequest;o.open("GET",e),o.responseType="blob",o.onload=function(){r(o.response,t,n)},o.onerror=function(){console.error("could not download file")},o.send()}function o(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function i(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(n){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var s="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof globalThis&&globalThis.global===globalThis?globalThis:void 0,a=s.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),r=s.saveAs||("object"!=typeof window||window!==s?function(){}:"download"in HTMLAnchorElement.prototype&&!a?function(e,t,a){var r=s.URL||s.webkitURL,l=document.createElement("a");t=t||e.name||"download",l.download=t,l.rel="noopener","string"==typeof e?(l.href=e,l.origin===location.origin?i(l):o(l.href)?n(e,t,a):i(l,l.target="_blank")):(l.href=r.createObjectURL(e),setTimeout(function(){r.revokeObjectURL(l.href)},4e4),setTimeout(function(){i(l)},0))}:"msSaveOrOpenBlob"in navigator?function(e,s,a){if(s=s||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,a),s);else if(o(e))n(e,s,a);else{var r=document.createElement("a");r.href=e,r.target="_blank",setTimeout(function(){i(r)})}}:function(e,t,o,i){if((i=i||open("","_blank"))&&(i.document.title=i.document.body.innerText="downloading..."),"string"==typeof e)return n(e,t,o);var r="application/octet-stream"===e.type,l=/constructor/i.test(s.HTMLElement)||s.safari,c=/CriOS\/[\d]+/.test(navigator.userAgent);if((c||r&&l||a)&&"undefined"!=typeof FileReader){var d=new FileReader;d.onloadend=function(){var e=d.result;e=c?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),i?i.location.href=e:location=e,i=null},d.readAsDataURL(e)}else{var p=s.URL||s.webkitURL,u=p.createObjectURL(e);i?i.location=u:location.href=u,i=null,setTimeout(function(){p.revokeObjectURL(u)},4e4)}});s.saveAs=r.saveAs=r,e.exports=r})?n.apply(t,o):n)||(e.exports=i)}}]); |