Document Automation Cloud API

Browse our Products

Are you looking for an evaluation version of a product?

If so you can download any of the below versions for testing. The product will function as normal except for an evaluation limitation. At the time of purchase we provide a license file via email that will allow the product to work in its full capacity. If you would also like an evaluation license to test without any restrictions for 30 days, please follow the directions provided here.

Are you having troubles in downloading?

If you experience errors, when you try to download a file, make sure your network policies (enforced by your company or ISP) allow downloading ZIP and/or MSI files.

Installation
The package is available at nuget.org and it can be installed via package manager console by executing following command:
PM> NuGet\Install-Package GroupDocs.Assembly-Cloud

Quick Start Guide

1. Create an Account

2. Create an API Client App

In the GroupDocs Cloud Dashboard, create a new application or use an existing one to obtain your App SID and App Key.

3. Install the SDK

Add the GroupDocs.Assembly Cloud SDK for .NET by running this command in the Package Manager Console in Visual Studio:

Install-Package GroupDocs.Assembly-Cloud

To update the SDK, use:

Update-Package GroupDocs.Assembly-Cloud

4. Make an API Request

Use your App SID and App Key to authenticate, upload a template, and assemble a document from JSON or XML data:

// For complete examples and data files, please go to https://github.com/groupdocs-assembly-cloud/groupdocs-assembly-cloud-dotnet
// Get App SID and App Key from https://dashboard.groupdocs.cloud
using GroupDocs.Assembly.Cloud.Sdk;
using GroupDocs.Assembly.Cloud.Sdk.Model;
using GroupDocs.Assembly.Cloud.Sdk.Model.Requests;
using System.IO;

var config = new Configuration
{
    AppSid = "####-####-####-####-####",
    AppKey = "##################"
};
var assemblyApi = new AssemblyApi(config);

var fileName = "Input1.docx";
var dataFile = "Input2.json";

// Upload template
var uploadRequest = new UploadFileRequest(File.OpenRead(fileName), fileName);
assemblyApi.UploadFile(uploadRequest);

// Assemble document
var assembleOptions = new AssembleOptions
{
    SaveFormat = "docx",
    ReportData = File.ReadAllText(dataFile),
    TemplateFileInfo = new TemplateFileInfo { FilePath = fileName }
};
var assembleRequest = new AssembleDocumentRequest(assembleOptions);
var assembledDocument = assemblyApi.AssembleDocument(assembleRequest);

Assemble Document to PDF

Generate a PDF report from an OpenDocument template and JSON data using GroupDocs.Assembly Cloud API.

// For complete examples and data files, please go to https://github.com/groupdocs-assembly-cloud/groupdocs-assembly-cloud-dotnet
using System;
using System.IO;
using GroupDocs.Assembly.Cloud.Sdk;
using GroupDocs.Assembly.Cloud.Sdk.Model;
using GroupDocs.Assembly.Cloud.Sdk.Model.Requests;

namespace Examples
{
    class Program
    {
        static void Main(string[] args)
        {
            var configuration = new Configuration
            {
                AppSid = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                AppKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
            };

            var assemblyApi = new AssemblyApi(configuration);

            var fileName = "TableFeatures.odt";
            var dataName = "TableData.json";
            var remotePath = "GroupDocs.Assembly/" + fileName;

            // Upload the template to cloud storage
            using (var templateStream = File.OpenRead(fileName))
            {
                var uploadRequest = new UploadFileRequest(templateStream, remotePath);
                assemblyApi.UploadFile(uploadRequest);
            }

            // Read JSON data and assemble the document as PDF
            var data = File.ReadAllText(dataName);
            var saveOptions = new AssembleOptions
            {
                SaveFormat = "pdf",
                ReportData = data,
                TemplateFileInfo = new TemplateFileInfo { FilePath = remotePath }
            };

            var request = new AssembleDocumentRequest(saveOptions);
            var result = assemblyApi.AssembleDocument(request);

            Console.WriteLine("Generated document length: " + result.Length);
        }
    }
}

Generate Invoice as PDF

Create a professional invoice from a Word template and JSON data, then save the result as PDF. Based on the invoice generation walkthrough.

// For complete examples, please go to https://blog.groupdocs.cloud/assembly/create-invoices-online-in-cloud/
using GroupDocs.Assembly.Cloud.Sdk;
using GroupDocs.Assembly.Cloud.Sdk.Model;
using GroupDocs.Assembly.Cloud.Sdk.Model.Requests;
using System.IO;

// Initialize the Assembly API
var config = new Configuration { AppSid = "YOUR_APP_SID", AppKey = "YOUR_APP_KEY" };
var assemblyApi = new AssemblyApi(config);

// Upload the invoice template to cloud storage
string cloudTemplatePath = "templates/invoice-template.docx";
using (var templateStream = File.OpenRead("resources/invoice-template.docx"))
{
    var uploadRequest = new UploadFileRequest(templateStream, cloudTemplatePath);
    assemblyApi.UploadFile(uploadRequest);
}

// Load JSON invoice data
string jsonData = File.ReadAllText("resources/invoice-data.json");

// Prepare assembly options — use "docx" for editable output, or "pdf" for distribution
var assembleOptions = new AssembleOptions
{
    SaveFormat = "pdf",
    ReportData = jsonData,
    TemplateFileInfo = new TemplateFileInfo
    {
        FilePath = "templates/invoice-template.docx"
    }
};

// Assemble the invoice and save it locally
var assembleRequest = new AssembleDocumentRequest(assembleOptions);
var assembledDocument = assemblyApi.AssembleDocument(assembleRequest);

using (var outputStream = File.Create("output/invoice-output.pdf"))
{
    assembledDocument.CopyTo(outputStream);
}

Sample JSON data for the invoice template:

{
  "invoice": {
    "number": "INV-2024-001",
    "issueDate": "2024-01-15T00:00:00"
  },
  "customer": {
    "name": "John Smith",
    "company": "Acme Corporation",
    "email": "john.smith@example.com",
    "address": "123 Main Street",
    "city": "New York",
    "state": "NY",
    "zipCode": "10001",
    "country": "USA"
  },
  "items": [
    {
      "description": "Web Development Services",
      "quantity": 40,
      "unitPrice": 150.00
    },
    {
      "description": "UI/UX Design",
      "quantity": 20,
      "unitPrice": 120.00
    },
    {
      "description": "Consulting Services",
      "quantity": 10,
      "unitPrice": 200.00
    }
  ],
  "taxRate": 10.0
}

Sample Projects on GitHub

The GroupDocs.Assembly Cloud .NET SDK repository includes ready-to-run unit tests covering:

Category	Examples
Document Assembly	Assemble document from template and JSON data, generate PDF output
File Operations	Upload template files to cloud storage
Error Handling	Validate required `ReportData` in assemble requests

How to run the examples

Clone or download the SDK repository
Edit Settings/servercreds.json and set your AppSid and AppKey
Install the package: Install-Package GroupDocs.Assembly-Cloud
Run the tests in the GroupDocs.Assembly.Cloud.Sdk.Test project

For more details, visit Getting Started.