Skip to content

Commit 5145fd2

Browse files
Merge pull request #2157 from OpenSignLabs/prafull-opensignlabs-patch-14
Change API version from v1.2 to v1.1
2 parents 3c25b09 + 27c1c7e commit 5145fd2

1 file changed

Lines changed: 17 additions & 120 deletions

File tree

docs/docs/API-docs/v1.1/opensign.yaml

Lines changed: 17 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
openapi: 3.0.3
22
info:
3-
title: OpenSign API v1.2
3+
title: OpenSign API v1.1
44
description: |
5-
Welcome to the **OpenSign™ API v1.2** documentation.
5+
Welcome to the **OpenSign™ API v1.1** documentation.
66
77
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™ delivers robust solutions tailored to your needs.
88
@@ -13,8 +13,10 @@ info:
1313
- [OpenSign GitHub Repository](https://github.com/opensignlabs/opensign)
1414
- [Generate x-api-token](https://docs.opensignlabs.com/docs/help/Settings/APIToken) – Learn how to securely generate and manage your API token for authenticating requests.
1515
16-
**What’s New in v1.2**
17-
- **Get Template & Get Template List**: removed unnecessary parameters and separated prefill data from signer parameters.
16+
**What’s New in v1.1**
17+
- **Public Templates**: Create templates that can be shared via a public link. Any user with the link can generate and sign documents based on the template. Templates themselves cannot be edited through the public link.
18+
- **Prefill Widgets**: Add prefill widgets to documents before they are sent. Prefill widgets are supported in the following endpoints: draft documents, document creation, document creation with a template, draft templates, and public templates.
19+
1820
1921
x-api-token:
2022
description: "refer docs to generate api token [APIToken help](https://docs.opensignlabs.com/docs/help/Settings/APIToken)"
@@ -29,10 +31,10 @@ externalDocs:
2931
description: Find out more about OpenSign
3032
url: http://docs.opensignlabs.com
3133
servers:
32-
- url: https://sandbox.opensignlabs.com/api/v1.2
33-
- url: https://app.opensignlabs.com/api/v1.2
34-
- url: https://eu-app.opensignlabs.com/api/v1.2
35-
- url: https://staging-app.opensignlabs.com/api/v1.2
34+
- url: https://sandbox.opensignlabs.com/api/v1.1
35+
- url: https://app.opensignlabs.com/api/v1.1
36+
- url: https://eu-app.opensignlabs.com/api/v1.1
37+
- url: https://staging-app.opensignlabs.com/api/v1.1
3638
tags:
3739
- name: OpenSign
3840
description: OpenSource DocuSign alternative
@@ -2357,52 +2359,6 @@ paths:
23572359
$ref: '#/components/schemas/invalidtoken'
23582360
security:
23592361
- x-api-token: []
2360-
/signinglinks/{document_id}:
2361-
get:
2362-
tags:
2363-
- Documents
2364-
summary: Get Signing Links
2365-
description: |
2366-
The Get Signing Links API enables you to retrieve signing urls of signers for the document.
2367-
operationId: getsigninglinks
2368-
parameters:
2369-
- name: document_id
2370-
in: path
2371-
description: objectId of Document
2372-
required: true
2373-
style: simple
2374-
explode: false
2375-
schema:
2376-
type: string
2377-
format: string
2378-
example: aB2cc2hpbh
2379-
responses:
2380-
"200":
2381-
description: successful operation
2382-
content:
2383-
application/json:
2384-
schema:
2385-
$ref: '#/components/schemas/getsigninglinks'
2386-
"400":
2387-
description: "Something went wrong, please try again later!"
2388-
content:
2389-
application/json:
2390-
schema:
2391-
$ref: '#/components/schemas/inline_response_400_1'
2392-
"404":
2393-
description: Document not found!
2394-
content:
2395-
application/json:
2396-
schema:
2397-
$ref: '#/components/schemas/inline_response_404_3'
2398-
"405":
2399-
description: Invalid API Token!
2400-
content:
2401-
application/json:
2402-
schema:
2403-
$ref: '#/components/schemas/invalidtoken'
2404-
security:
2405-
- x-api-token: []
24062362
/drafttemplate:
24072363
post:
24082364
tags:
@@ -5148,6 +5104,8 @@ components:
51485104
note:
51495105
type: string
51505106
example: template note
5107+
folder:
5108+
$ref: '#/components/schemas/template_folder'
51515109
file:
51525110
type: string
51535111
example: https://templateuser.com
@@ -5157,20 +5115,7 @@ components:
51575115
signers:
51585116
type: array
51595117
items:
5160-
type: object
5161-
properties:
5162-
role:
5163-
type: string
5164-
example: ceo
5165-
name:
5166-
type: string
5167-
example: joe bee
5168-
email:
5169-
type: string
5170-
example: joebee@example.com
5171-
phone:
5172-
type: string
5173-
example: "456213871"
5118+
$ref: '#/components/schemas/template_Signers'
51745119
sendInOrder:
51755120
type: boolean
51765121
example: true
@@ -5193,9 +5138,7 @@ components:
51935138
example: false
51945139
remind_once_in_every:
51955140
type: number
5196-
example: 0
5197-
prefill:
5198-
$ref: '#/components/schemas/prefill'
5141+
example: 0
51995142
xml:
52005143
name: template
52015144
template_details:
@@ -5231,6 +5174,8 @@ components:
52315174
merge_certificate:
52325175
type: boolean
52335176
example: false
5177+
folder:
5178+
$ref: '#/components/schemas/template_folder'
52345179
file:
52355180
type: string
52365181
example: https://templateuser.com
@@ -5492,17 +5437,6 @@ components:
54925437
xml:
54935438
name: signerIpsResponse
54945439

5495-
getsigninglinks:
5496-
type: object
5497-
properties:
5498-
objectId:
5499-
type: string
5500-
format: string
5501-
example: hji2zxcv2P
5502-
signurl:
5503-
type: array
5504-
items:
5505-
$ref: '#/components/schemas/inline_response_doc_signurl'
55065440
formdataResponse:
55075441
type: object
55085442
properties:
@@ -5578,20 +5512,7 @@ components:
55785512
signers:
55795513
type: array
55805514
items:
5581-
type: object
5582-
properties:
5583-
role:
5584-
type: string
5585-
example: ceo
5586-
name:
5587-
type: string
5588-
example: joe bee
5589-
email:
5590-
type: string
5591-
example: joebee@example.com
5592-
phone:
5593-
type: string
5594-
example: "456213871"
5515+
$ref: '#/components/schemas/template_Signers'
55955516
sendInOrder:
55965517
type: boolean
55975518
example: true
@@ -5737,10 +5658,6 @@ components:
57375658
type: string
57385659
format: base64
57395660
example: base64 encoded pdf
5740-
file_password:
5741-
type: string
5742-
format: string
5743-
example: ""
57445661
title:
57455662
type: string
57465663
format: string
@@ -5831,10 +5748,6 @@ components:
58315748
type: string
58325749
format: base64
58335750
example: base64 encoded pdf
5834-
file_password:
5835-
type: string
5836-
format: string
5837-
example: ""
58385751
title:
58395752
type: string
58405753
format: string
@@ -5950,10 +5863,6 @@ components:
59505863
type: string
59515864
format: base64
59525865
example: base64 encoded pdf
5953-
file_password:
5954-
type: string
5955-
format: string
5956-
example: ""
59575866
title:
59585867
type: string
59595868
format: string
@@ -6217,10 +6126,6 @@ components:
62176126
description: You may provide the base64 encoded PDF file to replace the existing one
62186127
format: base64
62196128
example: ""
6220-
file_password:
6221-
type: string
6222-
format: string
6223-
example: ""
62246129
auto_reminder:
62256130
type: boolean
62266131
description: Set to true to enable automatic reminders. Set to false to disable them (default behavior). If the field is omitted or provided as an empty/invalid value, the template value is used.
@@ -6424,10 +6329,6 @@ components:
64246329
type: string
64256330
format: base64
64266331
example: base64 encoded pdf
6427-
file_password:
6428-
type: string
6429-
format: string
6430-
example: ""
64316332
title:
64326333
type: string
64336334
format: string
@@ -6589,10 +6490,6 @@ components:
65896490
description: You may provide the base64 encoded PDF file to replace the existing one
65906491
format: base64
65916492
example: ""
6592-
file_password:
6593-
type: string
6594-
format: string
6595-
example: ""
65966493
redirect_url:
65976494
type: string
65986495
description: Specifies the URL where the signer will be redirected upon completing the document signing process.

0 commit comments

Comments
 (0)