Skip to content

Commit c3cf005

Browse files
Change API version from v1.2 to v1.1
Updated API version from v1.2 to v1.1 and modified documentation accordingly. Removed deprecated endpoints and added new features related to public templates and prefill widgets.
1 parent 3c25b09 commit c3cf005

1 file changed

Lines changed: 21 additions & 121 deletions

File tree

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

Lines changed: 21 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
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
7-
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.
7+
Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a devloper automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign™ delivers robust solutions tailored to your needs.
88
99
Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign™ and transform your digital document processes.
1010
@@ -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,13 @@ 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+
# Added by API Auto Mocking Plugin
35+
- description: SwaggerHub API Auto Mocking
36+
url: https://virtserver.swaggerhub.com/PrafullNavkar/open/1.0.0
37+
- url: https://sandbox.opensignlabs.com/api/v1.1
38+
- url: https://app.opensignlabs.com/api/v1.1
39+
- url: https://eu-app.opensignlabs.com/api/v1.1
40+
- url: https://staging-app.opensignlabs.com/api/v1.1
3641
tags:
3742
- name: OpenSign
3843
description: OpenSource DocuSign alternative
@@ -2357,52 +2362,6 @@ paths:
23572362
$ref: '#/components/schemas/invalidtoken'
23582363
security:
23592364
- 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: []
24062365
/drafttemplate:
24072366
post:
24082367
tags:
@@ -5148,6 +5107,8 @@ components:
51485107
note:
51495108
type: string
51505109
example: template note
5110+
folder:
5111+
$ref: '#/components/schemas/template_folder'
51515112
file:
51525113
type: string
51535114
example: https://templateuser.com
@@ -5157,20 +5118,7 @@ components:
51575118
signers:
51585119
type: array
51595120
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"
5121+
$ref: '#/components/schemas/template_Signers'
51745122
sendInOrder:
51755123
type: boolean
51765124
example: true
@@ -5193,9 +5141,7 @@ components:
51935141
example: false
51945142
remind_once_in_every:
51955143
type: number
5196-
example: 0
5197-
prefill:
5198-
$ref: '#/components/schemas/prefill'
5144+
example: 0
51995145
xml:
52005146
name: template
52015147
template_details:
@@ -5231,6 +5177,8 @@ components:
52315177
merge_certificate:
52325178
type: boolean
52335179
example: false
5180+
folder:
5181+
$ref: '#/components/schemas/template_folder'
52345182
file:
52355183
type: string
52365184
example: https://templateuser.com
@@ -5492,17 +5440,6 @@ components:
54925440
xml:
54935441
name: signerIpsResponse
54945442

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'
55065443
formdataResponse:
55075444
type: object
55085445
properties:
@@ -5578,20 +5515,7 @@ components:
55785515
signers:
55795516
type: array
55805517
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"
5518+
$ref: '#/components/schemas/template_Signers'
55955519
sendInOrder:
55965520
type: boolean
55975521
example: true
@@ -5737,10 +5661,6 @@ components:
57375661
type: string
57385662
format: base64
57395663
example: base64 encoded pdf
5740-
file_password:
5741-
type: string
5742-
format: string
5743-
example: ""
57445664
title:
57455665
type: string
57465666
format: string
@@ -5831,10 +5751,6 @@ components:
58315751
type: string
58325752
format: base64
58335753
example: base64 encoded pdf
5834-
file_password:
5835-
type: string
5836-
format: string
5837-
example: ""
58385754
title:
58395755
type: string
58405756
format: string
@@ -5950,10 +5866,6 @@ components:
59505866
type: string
59515867
format: base64
59525868
example: base64 encoded pdf
5953-
file_password:
5954-
type: string
5955-
format: string
5956-
example: ""
59575869
title:
59585870
type: string
59595871
format: string
@@ -6217,10 +6129,6 @@ components:
62176129
description: You may provide the base64 encoded PDF file to replace the existing one
62186130
format: base64
62196131
example: ""
6220-
file_password:
6221-
type: string
6222-
format: string
6223-
example: ""
62246132
auto_reminder:
62256133
type: boolean
62266134
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 +6332,6 @@ components:
64246332
type: string
64256333
format: base64
64266334
example: base64 encoded pdf
6427-
file_password:
6428-
type: string
6429-
format: string
6430-
example: ""
64316335
title:
64326336
type: string
64336337
format: string
@@ -6589,10 +6493,6 @@ components:
65896493
description: You may provide the base64 encoded PDF file to replace the existing one
65906494
format: base64
65916495
example: ""
6592-
file_password:
6593-
type: string
6594-
format: string
6595-
example: ""
65966496
redirect_url:
65976497
type: string
65986498
description: Specifies the URL where the signer will be redirected upon completing the document signing process.

0 commit comments

Comments
 (0)