Create New Template

Create a new template. You can use this API endpoint to upload a new PDF directly, create a new template from a previously uploaded PDF, or create a new HTML template.

HTTP Request

POST https://api.docspring.com/api/v1/templates

Parameters

Upload a PDF with a Form POST

You can create a new PDF template by making a multipart/form-data form post. The following form params are required:

template[document] - Your PDF file data
template[name] - The name of your new PDF template

The following form params are optional:

template[parent_folder_id] - The folder id that you want PDF template to be created under

Create an HTML Template

You can create a new HTML template by sending a JSON object as the POST body. All properties must be nested under a template key:

template_type (string, required): Must be "html".
name (string, required): The name of your template
html (string, required): HTML for your template
scss (string, optional): SCSS for your template
header_html (string, optional): HTML for the template header
footer_html (string, optional): HTML for the template footer

Example:

{
  "template": {
    "template_type": "html",
    "name": "Example HTML Template",
    "html": "<html><body>Example HTML</body></html>",
    "scss": "Your CSS here",
    "header_html": "Example Header HTML",
    "footer_html": "Example Footer HTML"
  }
}

Authentication

You must send an Authorization header with the value Basic followed by base 64 encoded token_id:token_secret.

For example: Authorization: Basic dG9rZW5faWQ6dG9rZW5fc2VjcmV0Cg==

See the Authentication documentation for more information.

Example Code

var DocSpring = require('docspring')

var config = new DocSpring.Configuration()
config.apiTokenId = 'DOCSPRING_TOKEN_ID'
config.apiTokenSecret = 'DOCSPRING_TOKEN_SECRET'
client = new DocSpring.Client(config)

var fs = require('fs')
var templateDocument = fs.createReadStream('path/to/your/pdf_document.pdf') // File |
var templateName = 'New Template Name' // String |
var parentFolderId = null
instance.createPDFTemplate(
  templateDocument,
  templateName,
  parentFolderId,
  function (error, template) {
    if (error) throw error
    console.log(template.id, template.name, template.document_url)
  }
)

// You can run this example in the PHP interactive shell (php -a)
// Find your API tokens here: https://app.docspring.com/api_tokens

$docspring = new \DocSpring\Client();
$docspring->getConfig()
  ->setUsername("DOCSPRING_API_TOKEN_ID")
  ->setPassword("DOCSPRING_API_TOKEN_SECRET");

$create_template_data = new \DocSpring\Model\CreateHtmlTemplateData([
  "template" => [
    "template_type" => "html",
    "name" => "Test HTML Template",
    "html" => "Test HTML",
    "scss" => "Test SCSS",
    "header_html" => "Test Header HTML",
    "footer_html" => "Test Header HTML",
  ]
]); // \DocSpring\Model\CreateHtmlTemplateData |
$response = $this->docspring->createHTMLTemplate($create_template_data);
echo "Created new template with ID: " . $response->getId();

// Find your API tokens here: https://app.docspring.com/api_tokens

ApiClient client = new ApiClient("api_token_basic", "DOCSPRING_API_TOKEN_ID", "DOCSPRING_API_TOKEN_SECRET");
api = client.createService(PdfApi.class);

/*
import okhttp3.MediaType;
import okhttp3.MultipartBody;
import okhttp3.RequestBody;
 */

File templateDocumentFile = new File("./form.pdf");
RequestBody templateDocumentRequestBody = RequestBody.create(
    MediaType.parse("application/pdf"),
    templateDocumentFile
);
MultipartBody.Part templateDocumentPart = MultipartBody.Part.createFormData(
    "PDF",
    templateDocumentFile.getName(),
    templateDocumentRequestBody
);
String templateName = "New Uploaded Template";
String templateParentFolderId = null;

retrofit2.Response<PendingTemplate> retrofitResponse = api.createPDFTemplate(
  templateDocumentPart,
  templateName,
  templateParentFolderId
).execute();
if (!retrofitResponse.isSuccessful()) {
  logger.info(retrofitResponse.errorBody().string());
}
PendingTemplate template = retrofitResponse.body();

  System.out.printf("Uploaded template! ID: %s", template.getId());

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class DocSpringExample
    {
        public void main()
        {
          Configuration.Default.Username = "DOCSPRING_TOKEN_ID";
          Configuration.Default.Password = "DOCSPRING_TOKEN_SECRET";

          var apiInstance = new PDFApi();
          Stream templateDocument = File.OpenRead("path/to/your/document.pdf");
          string templateName = "Your Template Name";
          var pendingTemplate = instance.CreatePDFTemplate(templateDocument, templateName);

          Debug.WriteLine(pendingTemplate.Id);
          Debug.WriteLine(pendingTemplate.Name);
        }
    }
}

Templates