|
2 | 2 |
|
3 | 3 | ### GitHub repo: [code-examples-php](./README.md) |
4 | 4 |
|
5 | | -This GitHub repo includes code examples for the DocuSign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API. To switch between API code examples, modify the `EXAMPLES_API_TYPE` setting in the ds_config.php file. Set only one API type to `true` and set the remaining to `false`. |
| 5 | +This GitHub repo includes code examples for the Docusign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API. To switch between API code examples, modify the `EXAMPLES_API_TYPE` setting in the ds_config.php file. Set only one API type to `true` and set the remaining to `false`. |
6 | 6 |
|
7 | | -If none of the API types are set to `true`, the DocuSign eSignature REST API code examples will be shown. If multiple API types are set to `true`, only the first will be shown. |
| 7 | +If none of the API types are set to `true`, the Docusign eSignature REST API code examples will be shown. If multiple API types are set to `true`, only the first will be shown. |
8 | 8 |
|
9 | 9 |
|
10 | 10 | ## Introduction |
11 | 11 | This repo is a PHP application that supports the following authentication workflows: |
12 | 12 |
|
13 | | -* Authentication with DocuSign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode). |
| 13 | +* Authentication with Docusign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode). |
14 | 14 | When the token expires, the user is asked to re-authenticate. The refresh token is not used. |
15 | 15 |
|
16 | | -* Authentication with DocuSign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/). |
| 16 | +* Authentication with Docusign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/). |
17 | 17 | When the token expires, it updates automatically. |
18 | 18 |
|
19 | 19 |
|
20 | | -The [PHP OAuth 2.0 Client package](http://oauth2-client.thephpleague.com/) is used for authentication. This launcher includes a DocuSign OAuth2 [provider](src/Controllers/Auth/DocuSign.php) for the OAuth package and a [resource owner](src/Controllers/Auth/DocuSignResourceOwner.php) to process the results of the call to OAuth::getUser. |
| 20 | +The [PHP OAuth 2.0 Client package](http://oauth2-client.thephpleague.com/) is used for authentication. This launcher includes a Docusign OAuth2 [provider](src/Controllers/Auth/Docusign.php) for the OAuth package and a [resource owner](src/Controllers/Auth/DocusignResourceOwner.php) to process the results of the call to OAuth::getUser. |
21 | 21 |
|
22 | 22 | The OAuth library is used in the file [index.php](./public/index.php). |
23 | 23 |
|
24 | 24 | ## eSignature API |
25 | 25 |
|
26 | 26 | For more information about the scopes used for obtaining authorization to use the eSignature API, see [Required scopes](https://developers.docusign.com/docs/esign-rest-api/esign101/auth#required-scopes). |
27 | 27 |
|
28 | | -For a list of code examples that use the eSignature API, see the [How-to guides overview](https://developers.docusign.com/docs/esign-rest-api/how-to/) on the DocuSign Developer Center. |
| 28 | +For a list of code examples that use the eSignature API, see the [How-to guides overview](https://developers.docusign.com/docs/esign-rest-api/how-to/) on the Docusign Developer Center. |
29 | 29 |
|
30 | 30 |
|
31 | 31 | ## Rooms API |
32 | 32 |
|
33 | | -**Note:** To use the Rooms API, you must also [create your Rooms developer account](https://developers.docusign.com/docs/rooms-api/rooms101/create-account). Examples 4 and 6 require that you have the DocuSign Forms feature enabled in your Rooms for Real Estate account. |
| 33 | +**Note:** To use the Rooms API, you must also [create your Rooms developer account](https://developers.docusign.com/docs/rooms-api/rooms101/create-account). Examples 4 and 6 require that you have the Docusign Forms feature enabled in your Rooms for Real Estate account. |
34 | 34 | For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/rooms-api/rooms101/auth/). |
35 | 35 |
|
36 | | -For a list of code examples that use the Rooms API, see the [How-to guides overview](https://developers.docusign.com/docs/rooms-api/how-to/) on the DocuSign Developer Center. |
| 36 | +For a list of code examples that use the Rooms API, see the [How-to guides overview](https://developers.docusign.com/docs/rooms-api/how-to/) on the Docusign Developer Center. |
37 | 37 |
|
38 | 38 |
|
39 | 39 | ## Click API |
40 | 40 | For more information about the scopes used for obtaining authorization to use the Click API, see [Required scopes](https://developers.docusign.com/docs/click-api/click101/auth/#required-scopes) |
41 | 41 |
|
42 | | -For a list of code examples that use the Click API, see the [How-to guides overview](https://developers.docusign.com/docs/click-api/how-to/) on the DocuSign Developer Center. |
| 42 | +For a list of code examples that use the Click API, see the [How-to guides overview](https://developers.docusign.com/docs/click-api/how-to/) on the Docusign Developer Center. |
43 | 43 |
|
44 | 44 |
|
45 | 45 | ## Monitor API |
46 | 46 |
|
47 | | -**Note:** To use the Monitor API, you must also [enable DocuSign Monitor for your organization](https://developers.docusign.com/docs/monitor-api/how-to/enable-monitor/). |
| 47 | +**Note:** To use the Monitor API, you must also [enable Docusign Monitor for your organization](https://developers.docusign.com/docs/monitor-api/how-to/enable-monitor/). |
48 | 48 |
|
49 | 49 | For information about the scopes used for obtaining authorization to use the Monitor API, see the [scopes section](https://developers.docusign.com/docs/monitor-api/monitor101/auth/). |
50 | 50 |
|
51 | | -For a list of code examples that use the Monitor API, see the [How-to guides overview](https://developers.docusign.com/docs/monitor-api/how-to/) on the DocuSign Developer Center. |
| 51 | +For a list of code examples that use the Monitor API, see the [How-to guides overview](https://developers.docusign.com/docs/monitor-api/how-to/) on the Docusign Developer Center. |
52 | 52 |
|
53 | 53 |
|
54 | 54 | ## Admin API |
55 | 55 |
|
56 | | -**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your DocuSign developer account. Also, to run the DocuSign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/DocuSign-and-SpringCM). |
| 56 | +**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your Docusign developer account. Also, to run the Docusign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/Docusign-and-SpringCM). |
57 | 57 |
|
58 | 58 | For information about the scopes used for obtaining authorization to use the Admin API, see the [scopes section](https://developers.docusign.com/docs/admin-api/admin101/auth/). |
59 | 59 |
|
60 | | -For a list of code examples that use the Admin API, see the [How-to guides overview](https://developers.docusign.com/docs/admin-api/how-to/) on the DocuSign Developer Center. |
| 60 | +For a list of code examples that use the Admin API, see the [How-to guides overview](https://developers.docusign.com/docs/admin-api/how-to/) on the Docusign Developer Center. |
61 | 61 |
|
62 | 62 |
|
63 | 63 | ## Web Forms API |
64 | 64 |
|
65 | | -The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact [DocuSign Support](https://support.docusign.com/) or your account manager to find out whether the Web Forms API is available for your production account plan. |
| 65 | +The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support](https://support.docusign.com/) or your account manager to find out whether the Web Forms API is available for your production account plan. |
66 | 66 |
|
67 | 67 | For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/web-forms-api/plan-integration/authentication/). |
68 | 68 |
|
69 | | -For a list of code examples that use the Web Forms API, see the [How-to guides overview](https://developers.docusign.com/docs/web-forms-api/how-to/) on the DocuSign Developer Center. |
| 69 | +For a list of code examples that use the Web Forms API, see the [How-to guides overview](https://developers.docusign.com/docs/web-forms-api/how-to/) on the Docusign Developer Center. |
70 | 70 |
|
71 | 71 |
|
72 | 72 | ## Installation |
73 | 73 |
|
74 | 74 | ### Prerequisites |
75 | 75 |
|
76 | | -**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart) from the DocuSign Developer Center, skip items 1 and 2 below as they were automatically performed for you. |
| 76 | +**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart) from the Docusign Developer Center, skip items 1 and 2 below as they were automatically performed for you. |
77 | 77 |
|
78 | | -1. A free [DocuSign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one. |
79 | | -1. A DocuSign app and integration key that is configured to use either [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) or [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication. |
| 78 | +1. A free [Docusign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one. |
| 79 | +1. A Docusign app and integration key that is configured to use either [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) or [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication. |
80 | 80 |
|
81 | 81 | This [video](https://www.youtube.com/watch?v=eiRI4fe5HgM) demonstrates how to obtain an integration key. |
82 | 82 |
|
@@ -104,7 +104,7 @@ For a list of code examples that use the Web Forms API, see the [How-to guides o |
104 | 104 |
|
105 | 105 | ### Installation steps |
106 | 106 |
|
107 | | -**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart) from the DocuSign Developer Center, skip step 4 below as it was automatically performed for you. |
| 107 | +**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart) from the Docusign Developer Center, skip step 4 below as it was automatically performed for you. |
108 | 108 |
|
109 | 109 | 1. Extract the Quickstart ZIP file or download or clone the code-examples-php repository. |
110 | 110 | 1. In your command-line environment, switch to the folder: `cd <Quickstart_folder>` or `cd code-examples-php` |
@@ -196,7 +196,7 @@ Apache will run. |
196 | 196 |
|
197 | 197 |
|
198 | 198 | ## JWT grant remote signing and Authorization Code Grant embedded signing projects |
199 | | -See [DocuSign Quickstart overview](https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/) on the DocuSign Developer Center for more information on how to run the JWT grant remote signing and the Authorization Code Grant embedded signing project. |
| 199 | +See [Docusign Quickstart overview](https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/) on the Docusign Developer Center for more information on how to run the JWT grant remote signing and the Authorization Code Grant embedded signing project. |
200 | 200 |
|
201 | 201 |
|
202 | 202 | ## Payments code example |
|
0 commit comments