{"id":4033,"date":"2021-01-17T19:39:48","date_gmt":"2021-01-18T00:39:48","guid":{"rendered":"https:\/\/swiftcloud.ai\/support\/?p=4033"},"modified":"2021-01-26T17:49:16","modified_gmt":"2021-01-26T22:49:16","slug":"electronic-signature-api","status":"publish","type":"post","link":"https:\/\/swiftcloud.ai\/supportwebadmin\/electronic-signature-api","title":{"rendered":"API: Electronic Signature"},"content":{"rendered":"<h3>Note our Electronic Signature API has 2 parts: Inbound &amp; Outbound<\/h3>\n<ul>\n<li><strong>eSign \/ eDocs: Inbound<\/strong>: Inject variables into a contract or doc to be signed. This can even include a base 64 image (say, for an X-ray image, or driver&#8217;s license)<\/li>\n<li><strong>eSign \/ eDocs: Outbound<\/strong>: Notification when a doc is signed, including with the URL of the signed doc &lt;requires permissions and IP restriction to download&gt;<\/li>\n<\/ul>\n<h2>INBOUND Electronic Signature \/ eDocs API<\/h2>\n<blockquote>\n<h3>GOAL (Most Common):<br \/>\nSend variables into an e-Sign Contract.<\/h3>\n<\/blockquote>\n<p>METHODS:<\/p>\n<ul>\n<li>POST (simple and fast)<\/li>\n<li>GET (URL string)<\/li>\n<li>API (below)<\/li>\n<\/ul>\n<blockquote><p>NOTE: API in is easy, there&#8217;s no security risk. API outbound, for security reasons, is much more restrictive. You will need API keys and IP based restriction on outbound APIs.<\/p><\/blockquote>\n<h2><strong>POST (METHOD 1)<\/strong><\/h2>\n<p>You can simply post any variables into a SwiftCloud doc, and as long as the variable matches, SwiftCloud will handle the rest. You can add &#8220;readonly&#8221; into the shortcode to make it look like regular text, not front-end-editable.<\/p>\n<p>Post location: Simply post right to your actual doc URL. Ensure the variable names match in the source-code, and we&#8217;ll do the rest. You can optionally include hidden variables (like session ID, tracking variables).<\/p>\n<p>NOTE: Inbound API is throttled. If you are running TV ads or expect a large number of submissions in a short time period, let us know.<\/p>\n<h2><strong>GET (METHOD 2)<\/strong><\/h2>\n<p>Simply append any variable to the end of your eSign doc \/ eDoc \/ Landing Page \/ Scheduler \/ etc &#8211; i.e.<\/p>\n<pre>https:\/\/LinkToYourPageHere.ai?swift_email=John@Doe.com&amp;extra_sessionID=1234<\/pre>\n<h4>More Common Use Cases<\/h4>\n<ul>\n<li>Facebook Lead Form Ads &#8211; Will notify you, create the workroom, fire autoresponder messages, create the contact<\/li>\n<li>Zapier, IFFFT, Tray.IO, n8n.io (API bridge systems) integrations<\/li>\n<li>WordPress Forms for lead capture etc.<\/li>\n<li>Any other data capture, lead capture<\/li>\n<\/ul>\n<h2><strong>API INBOUND (METHOD 3)<\/strong><\/h2>\n<p>Below is details for our incoming API using Json.<\/p>\n<h3>HOW TO USE IT<\/h3>\n<ol>\n<li>Create a Form same as usual &#8211; go to your main drive page. Click the orange Create New button, select Form, and give it a name (just for you, not visible to clients). Move to a subfolder if you choose.<\/li>\n<li>Next, at the very top, choose API or Facebook. Both do the same, but Facebook will help you connect directly.<\/li>\n<li>In the pink box, set what you want to happen for the guest \/ client \/ form-filler &#8211; what email they should get if any, and any optional sequence of messages.<\/li>\n<li>In the blue box, set your own notification options. Email you? Email someone else? Configure as needed<\/li>\n<li>You&#8217;re done &#8211; most likely. More advanced optional controls are available in the grey box for non-english language controls, etc.<\/li>\n<\/ol>\n<h3>CODE EXAMPLE<\/h3>\n<p>Note 2 bits of data are always required for the absolute bare minimum:<\/p>\n<ol>\n<li>Form ID<\/li>\n<li>Email*<\/li>\n<\/ol>\n<p>*Note we may soon allow mobile phone (with SMS verification); if you need this let us know.<\/p>\n<p>POST TO: https:\/\/swiftcrm.com\/is\/api\/formhandlings<\/p>\n<p>Login is not required. No data can be retrieved from this API. We may add IP restriction down the road if needed.<\/p>\n<p><b>Set the header for API :<\/b><span style=\"font-weight: 400;\"> \u00a0<\/span><span style=\"font-weight: 400;\">Content-Type :<\/span><span style=\"font-weight: 400;\"> application\/json<\/span><\/p>\n<blockquote><p>NOTE: KNOWN ISSUE: Underscore _ is not allowed in variable names. This message will be removed when solved; for now just please use &#8211; hyphen instead of _ underscore in the variable names.<\/p><\/blockquote>\n<pre><span style=\"font-weight: 400;\">{\"formid\":\"233F283\",<\/span>\r\n<span style=\"font-weight: 400;\">\"swift_name_both\":\"Tester Name\",<\/span>\r\n<span style=\"font-weight: 400;\">\"email\":\"wamasoftware2@gmail.com\",<\/span>\r\n<span style=\"font-weight: 400;\">\"FundsNeededFor\":\"new tractor\"}<\/span><\/pre>\n<h3>API Response:<\/h3>\n<pre>success, fail<\/pre>\n<p>As always, if you have any questions let us know and we&#8217;ll update this entry to be more clear.<\/p>\n<h2>OUTBOUND Electronic Signature \/ eDocs API<\/h2>\n<p>Most common: Simply select the Remote Post option in the blue box on a form, doc, chatbot, landing page, etc. and define the remote URL.<\/p>\n<blockquote><p>TIP: See <a href=\"http:\/\/swiftcloud.ai\/supportwebadmin\/fieldname-translator\" class=\"broken_link\">Fieldname Translator (Json Variables Renamed)<\/a><\/p><\/blockquote>\n<p>Inside the Json Variables you can also include necessary items like a security token, your User ID, etc &#8211; variables that do not exist on our system. If SwiftCloud does not recognize the us-variable, we&#8217;ll just ignore it.<\/p>\n<p>If you wish to store the PDFs (eSign, Invoices) remotely, check the box. It will ask for your IP address of the remote server; we&#8217;ll override privacy settings on PDF-retrieval if the request originates from that address. A <strong>security token<\/strong> is also required, which you can find on your User Profile &gt;&gt; Accessing SwiftCloud; this must be passed with each request.<\/p>\n<p><strong>Your remote system must originate the PDF-request &#8211; i.e. you pull it.<\/strong> This allows you to pull it anytime, or pull only what&#8217;s needed, or pull after certain conditions are met such as all parties of signed a doc and not just some of them.<\/p>\n<p><img decoding=\"async\" loading=\"lazy\" class=\"alignnone size-full wp-image-3789\" src=\"http:\/\/swiftcloud.ai\/supportwebadmin\/wp-content\/uploads\/2020\/04\/api_post_swiftcloud.png\" alt=\"SwiftCloud API Outbound\" width=\"578\" height=\"596\" srcset=\"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-content\/uploads\/2020\/04\/api_post_swiftcloud.png 578w, https:\/\/swiftcloud.ai\/supportwebadmin\/wp-content\/uploads\/2020\/04\/api_post_swiftcloud-291x300.png 291w\" sizes=\"(max-width: 578px) 100vw, 578px\" \/><\/p>\n<p>You must have a static IP address for this (all websites do, but if you&#8217;re looking to connect a local point-of-sale cash register etc, this may be a bit more complex).<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Note our Electronic Signature API has 2 parts: Inbound &amp; Outbound eSign \/ eDocs: Inbound: Inject variables into a contract or doc to be signed. This can even include a base 64 image (say, for an X-ray image, or driver&#8217;s &hellip;<\/p>\n<p class=\"read-more\"> <a class=\"\" href=\"https:\/\/swiftcloud.ai\/supportwebadmin\/electronic-signature-api\"> <span class=\"screen-reader-text\">API: Electronic Signature<\/span> Read More &raquo;<\/a><\/p>\n<div class=\"blog_postmeta\"><div class=\"blog-tags\"><ul><li><a rel=\"canonical\" href=\"https:\/\/swiftcloud.ai\/supportwebadmin\/tag\/api\">api<\/a><\/li><li><a rel=\"canonical\" href=\"https:\/\/swiftcloud.ai\/supportwebadmin\/tag\/electronic-signature\">electronic signature<\/a><\/li><li><a rel=\"canonical\" href=\"https:\/\/swiftcloud.ai\/supportwebadmin\/tag\/technical\">Technical<\/a><\/li><\/ul><\/div><div class=\"blog-categories text-right\"><a rel=\"canonical\" data-toggle=\"tooltip\" data-placement=\"bottom\" title=\"Support entries for our Electronic Signature system.\n\" href=\"https:\/\/swiftcloud.ai\/supportwebadmin\/category\/electronic-signature\">electronic signature<\/a><\/div><\/div>","protected":false},"author":7,"featured_media":3158,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""}},"footnotes":""},"categories":[398],"tags":[65,89,477],"_links":{"self":[{"href":"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-json\/wp\/v2\/posts\/4033"}],"collection":[{"href":"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-json\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-json\/wp\/v2\/comments?post=4033"}],"version-history":[{"count":3,"href":"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-json\/wp\/v2\/posts\/4033\/revisions"}],"predecessor-version":[{"id":4150,"href":"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-json\/wp\/v2\/posts\/4033\/revisions\/4150"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-json\/wp\/v2\/media\/3158"}],"wp:attachment":[{"href":"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-json\/wp\/v2\/media?parent=4033"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-json\/wp\/v2\/categories?post=4033"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/swiftcloud.ai\/supportwebadmin\/wp-json\/wp\/v2\/tags?post=4033"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}