Skip to content

Commit 3c25b09

Browse files
Upgrade OpenSign API documentation to v1.2
Updated API documentation to version 1.2, including new features and endpoint changes.
1 parent afe753f commit 3c25b09

1 file changed

Lines changed: 120 additions & 17 deletions

File tree

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

Lines changed: 120 additions & 17 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.1
3+
title: OpenSign API v1.2
44
description: |
5-
Welcome to the **OpenSign™ API v1.1** documentation.
5+
Welcome to the **OpenSign™ API v1.2** 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,10 +13,8 @@ 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.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-
16+
**What’s New in v1.2**
17+
- **Get Template & Get Template List**: removed unnecessary parameters and separated prefill data from signer parameters.
2018
2119
x-api-token:
2220
description: "refer docs to generate api token [APIToken help](https://docs.opensignlabs.com/docs/help/Settings/APIToken)"
@@ -31,10 +29,10 @@ externalDocs:
3129
description: Find out more about OpenSign
3230
url: http://docs.opensignlabs.com
3331
servers:
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
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
3836
tags:
3937
- name: OpenSign
4038
description: OpenSource DocuSign alternative
@@ -2359,6 +2357,52 @@ paths:
23592357
$ref: '#/components/schemas/invalidtoken'
23602358
security:
23612359
- 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: []
23622406
/drafttemplate:
23632407
post:
23642408
tags:
@@ -5104,8 +5148,6 @@ components:
51045148
note:
51055149
type: string
51065150
example: template note
5107-
folder:
5108-
$ref: '#/components/schemas/template_folder'
51095151
file:
51105152
type: string
51115153
example: https://templateuser.com
@@ -5115,7 +5157,20 @@ components:
51155157
signers:
51165158
type: array
51175159
items:
5118-
$ref: '#/components/schemas/template_Signers'
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"
51195174
sendInOrder:
51205175
type: boolean
51215176
example: true
@@ -5138,7 +5193,9 @@ components:
51385193
example: false
51395194
remind_once_in_every:
51405195
type: number
5141-
example: 0
5196+
example: 0
5197+
prefill:
5198+
$ref: '#/components/schemas/prefill'
51425199
xml:
51435200
name: template
51445201
template_details:
@@ -5174,8 +5231,6 @@ components:
51745231
merge_certificate:
51755232
type: boolean
51765233
example: false
5177-
folder:
5178-
$ref: '#/components/schemas/template_folder'
51795234
file:
51805235
type: string
51815236
example: https://templateuser.com
@@ -5437,6 +5492,17 @@ components:
54375492
xml:
54385493
name: signerIpsResponse
54395494

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'
54405506
formdataResponse:
54415507
type: object
54425508
properties:
@@ -5512,7 +5578,20 @@ components:
55125578
signers:
55135579
type: array
55145580
items:
5515-
$ref: '#/components/schemas/template_Signers'
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"
55165595
sendInOrder:
55175596
type: boolean
55185597
example: true
@@ -5658,6 +5737,10 @@ components:
56585737
type: string
56595738
format: base64
56605739
example: base64 encoded pdf
5740+
file_password:
5741+
type: string
5742+
format: string
5743+
example: ""
56615744
title:
56625745
type: string
56635746
format: string
@@ -5748,6 +5831,10 @@ components:
57485831
type: string
57495832
format: base64
57505833
example: base64 encoded pdf
5834+
file_password:
5835+
type: string
5836+
format: string
5837+
example: ""
57515838
title:
57525839
type: string
57535840
format: string
@@ -5863,6 +5950,10 @@ components:
58635950
type: string
58645951
format: base64
58655952
example: base64 encoded pdf
5953+
file_password:
5954+
type: string
5955+
format: string
5956+
example: ""
58665957
title:
58675958
type: string
58685959
format: string
@@ -6126,6 +6217,10 @@ components:
61266217
description: You may provide the base64 encoded PDF file to replace the existing one
61276218
format: base64
61286219
example: ""
6220+
file_password:
6221+
type: string
6222+
format: string
6223+
example: ""
61296224
auto_reminder:
61306225
type: boolean
61316226
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.
@@ -6329,6 +6424,10 @@ components:
63296424
type: string
63306425
format: base64
63316426
example: base64 encoded pdf
6427+
file_password:
6428+
type: string
6429+
format: string
6430+
example: ""
63326431
title:
63336432
type: string
63346433
format: string
@@ -6490,6 +6589,10 @@ components:
64906589
description: You may provide the base64 encoded PDF file to replace the existing one
64916590
format: base64
64926591
example: ""
6592+
file_password:
6593+
type: string
6594+
format: string
6595+
example: ""
64936596
redirect_url:
64946597
type: string
64956598
description: Specifies the URL where the signer will be redirected upon completing the document signing process.

0 commit comments

Comments
 (0)