Git Product home page Git Product logo

sample-app's Introduction

signNow Sample App

PHP Version Laravel Version signNow PHP SDK Licence

About

This sample application demonstrates how the signNow API and PHP SDK can be used to construct applications with signing flows. This sample application operates using the following features:

Try using the sample application for testing purposes or use it as a skeleton for your own application. To create an application that generates legally binding signatures, you’ll need a signNow subscription.

Prerequisites

  • Create a signNow account:
    • For integration purposes, you need a signNow account with a paid subscription.
    • For testing purposes, you can create a signNow developer account.
  • At the API Dashboard, create an application.
  • Use your signNow credentials and basic authorization token in your config file .env.

Environment variables

The configuration file is located in the project directory with the common name .env.

Configure the following variables to ensure the application’s proper functionality.

Variable Example Description
SN_API_HOST https://api.signnow.com signNow API host
SN_API_BASIC_TOKEN c2lnbk5vdyBBUEkgc2FtcGxlIEFwcCB2MS4wCg== Find your basic token at the API Dashboard.
SN_API_USER [email protected] The email address of the document signer.
SN_API_PASSWORD ***** Your signNow account password.
SN_SIGNER_EMAIL [email protected] The email address of the person who is supposed to sign a document.

View the entire configuration file, including standard Laravel variables, here.

Get Started

  1. Clone the repository

    git clone [email protected]:signnow/sample-app.git
    
  2. Build a docker image using the following command:

    make build
    
  3. Start the signnow-sample-app docker container using the following command:

    make up
    
  4. Install dependencies and generate a Laravel application key using the following command:

    make setup
    

    This command will also prepare your configuration .env file and prompt you to enter all the required parameters. Make sure that you have the following data at hand:

    • Basic token for your application.
    • The email address that your signNow account is registered with.
    • Your signNow password.
    • The email address of the person who is supposed to sign a document.
  5. Clear the cache using the following command (optionally):

    make clear
    
  6. Open a browser to localhost:8080.

Behind the scenes

Technology:

  • PHP 8.2
  • Laravel 10
  • signNow API PHP SDK 2.2
  • Docker
  • Native JavaScript
  • HTML
  • Bootstrap CSS Framework

The application contains both backend and tiny frontend components. The frontend consists of a web form where you can enter the first and last names of your signer and a comment.

After the form is submitted, the backend uploads the PDF file to signNow using your credentials provided with the .env configuration file. The backend also adds the first and last names and comment fields to the document. The backend then creates an embedded invite to sign your document and generates a link for the invite. This type of invite is called 'embedded' because you can integrate it into your website or mobile application.

The frontend receives the invite link and embeds the signNow document editor into a website or app using an <iframe/> tag. Using this method, the signing session is built into the website. You can also customize the signing experience by using the branding feature. All backend operations are performed using the signNow PHP SDK.

More information

Topic URL
signNow website https://www.signnow.com/
PHP SDK https://github.com/signnow/SignNowPHPSDK
signNow documentation https://docs.signnow.com/

License

This repository is under the MIT license. You are free to use the code of this application as a skeleton for your application. For more information, see LICENSE.

sample-app's People

Contributors

jisoft avatar makshudzinovich avatar

Stargazers

Juan C. avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.