https://github.com/docusign/api-request-builder-open-src
A block-oriented request builder for the eSignature Envelopes:create API call
https://github.com/docusign/api-request-builder-open-src
Last synced: 12 months ago
JSON representation
A block-oriented request builder for the eSignature Envelopes:create API call
- Host: GitHub
- URL: https://github.com/docusign/api-request-builder-open-src
- Owner: docusign
- License: mit
- Created: 2020-09-16T10:43:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-19T22:19:18.000Z (about 5 years ago)
- Last Synced: 2025-03-25T18:45:41.919Z (about 1 year ago)
- Language: JavaScript
- Size: 1.51 MB
- Stars: 5
- Watchers: 8
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API Request Builder
Open Source
## Installation
1. `npm install`
1. Configure two private CORS gateways, one for https://account-d.docusign.com, and one for https://demo.docusign.net
See this [blog post](https://www.docusign.com/blog/dsdev-building-single-page-applications-with-docusign-and-cors-part-2) for more information and code examples.
1. Configure the `.env` file (See the `env.example` file.)
1. `npm start` (This takes several minutes! Very slow...)
1. `npm build` (Standard React build command.)
## Client id (Integration Key) settings
1. Enable `Implicit Grant`
1. Include a Redirect URI for `PUBLIC_URL/oauthResponse.html`
1. No secret is needed.
## Example diagrams
To add a new example diagram to the app, add the
diagram to the src/assets/diagramExamples folder.
## The app's API
The app can be started with a query parameter
to control the app.
### Load a specific example
Query parameter: `?eg=EXAMPLE_TITLE`
Where `EXAMPLE_TITLE` is the title of the example, with spaces and other characters encoded.
Example:
`http://localhost:3000/api-request-builder/build?eg=Require%20one%20of%20multiple%20checkboxes`
## Updating the Swagger file
1. Update the Swagger file stored in `/batch/esignature.rest.swagger-v2.1.json` from https://github.com/docusign/eSign-OpenAPI-Specification/
1. `npm run-script processSwagger`
1. Restart and test the application
## License
This software uses the MIT open source license. See the LICENSE file.
## Pull Requests
Pull requests that use the MIT license are welcomed.
## Issues / Questions
Please use the Issues page.