Skip to content

Commit 3a39782

Browse files
Update README.md with example list
1 parent 12de7d7 commit 3a39782

1 file changed

Lines changed: 25 additions & 3 deletions

File tree

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,11 @@ If you have questions about the SignNow API, please visit https://docs.signnow.c
1818
| Application: | https://app-eval.signnow.com | https://app.signnow.com |
1919
| Entry page: | https://eval.signnow.com |
2020

21-
#### Examples
22-
To run the examples you will need an API key. You can get one here https://www.signnow.com/api. For a full list of accepted parameters, refer to the SignNow REST Endpoints API guide: https://docs.signnow.com/reference.
23-
2421
## Contents
2522

2623
- [Documentation](#documentation)
2724
- [Get started](#get-started)
25+
- [Examples](#examples)
2826
- [Contribution guidelines](#contribution-guidelines)
2927
- [License](#license)
3028

@@ -56,6 +54,30 @@ SNClientBuilder.get("apiUrl", "clientId", "clientSecret");
5654
If you wish to run an example application - set parameters named in the ```\example-app\src\main\resources\application.properties```
5755
Feel free to try provided examples and explore corresponding code.
5856

57+
## <a name="examples"></a>Examples
58+
To run the examples you will need an API key. You can get one here https://www.signnow.com/api. For a full list of accepted parameters, refer to the SignNow REST Endpoints API guide: https://docs.signnow.com/reference.
59+
60+
**Note:** next examples is a list of common use-cases only, while client library is intend to provide general wrapper and DTO objects for API calls. Thus you are not limited to mentioned here examples and free to use any provided API mapped method.
61+
62+
##### User:
63+
* [Login](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Login.java#L37)
64+
65+
##### Document
66+
* [Retrieve a List of the User’s Documents](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Login.java#L46)
67+
* [Upload document](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Examples.java#L47)
68+
* [Upload File & Extract Fields](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Examples.java#L406)
69+
* [Update Document (add prefilled fields)](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Examples.java#L321)
70+
* [Update Document (add fields)](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Examples.java#L439)
71+
* [Create Free Form Invite](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Examples.java#L120)
72+
73+
##### Links
74+
* [Create signing link](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Examples.java#L79)
75+
76+
##### Template
77+
* [Create a Template](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Examples.java#L367)
78+
* [Create Invite to Sign a Template for multiple signers](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Examples.java#L175)
79+
* [Create Invite to Sign multiple Templates for multiple signers](https://github.com/signnow/SignNowJavaAPiClient/blob/12de7d7c760229fa865a6550dc5113f86683d11c/example-app/src/main/java/com/signnow/examples/controller/Examples.java#L248)
80+
5981

6082
## <a name="contribution-guidelines"></a>Contribution guidelines
6183
Thanks to all contributors who got interested in this project. We're excited to hear from you. Here are some tips to make our collaboration meaningful and bring its best results to life:

0 commit comments

Comments
 (0)