Documentation

Tags

The template is a document (docx) created in Microsoft Word or other software.


Simple tags

Hi {name}
{ 
    "name": "John Doe" 
}
Hi John Doe

Loops

{%list} {item1} {/list}
{ 
  "list": [
    {
      "item1": "aculis" 
    },
    {
      "item1": "faucibus" 
    },
    {
      "item1": "sit" 
    }
  ]
}
aculis faucibus sit

Conditions

{%if template == "Document"} YES {/if}
{
"template": "Document"
}
YES

Table rows

{tr%list} {item1} {tr/list}
{ 
  "list": [
    {
      "item1": "aculis" 
    },
    {
      "item1": "faucibus" 
    },
    {
      "item1": "sit" 
    }
  ]
}
aculis
faucibus
sit

Table columns

{tc%list} {item1} {tc/list}
{ 
  "list": [
    {
      "item1": "aculis" 
    },
    {
      "item1": "faucibus" 
    },
    {
      "item1": "sit" 
    }
  ]
}
aculis faucibus sit

Bullets

{bl%list} {item1} {bl/list}
{ 
  "list": [
    {
      "item1": "aculis" 
    },
    {
      "item1": "faucibus" 
    },
    {
      "item1": "sit" 
    }
  ]
}
  • aculis
  • faucibus
  • sit

Numbering

{nl%list} {item1} {nl/list}
{ 
  "list": [
    {
      "item1": "aculis" 
    },
    {
      "item1": "faucibus" 
    },
    {
      "item1": "sit" 
    }
  ]
}
  1. aculis
  2. faucibus
  3. sit

Images

 {smile}
{ 
    "smile": "image:iVBORw0KG..." 
}

Testing

You can use our API to access Semico contents.

When integrating and testing our API, please use the following URL:

https://nefiavt.azure-api.net

Authentication

Semico uses subscription keys to enable access to the API content and perform requests.

You can register a new Semico subscription key by contacting us.

Semico expects for the subscription key to be included in all API requests to the server in the header of the request that looks like the following:

subscription-key: 23117b5e1a13494cbaf908ca9ac8d8b0

Make sure to replace 23117b5e1a13494cbaf908ca9ac8d8b0 with your subscription key.

Generate Document

This endpoint is used to generate document.

HTTP Request

POST https://nefiavt.azure-api.net/api/v1/Semico/GenerateDocument

Header Parameters

Parameter Mandatory Description
subscription-key YES Enables access to the API

Body Parameters

Parameter Mandatory Description Example
template YES A base64 representation of a Word document (DOCX) UEsDBBQABgAIA....
data YES A base64 representation of a JSON document ew0KICAgICJ0Z....
options NO Additional options
"options": {
        "convertToPdf": true,
        "pdfOptions": {
            "additionalMetadata": "More metadata",
            "author": "Nefia",
            "producer": "Semico",
            "subject": "Semico client",
            "title": "PDF generation",
            "application": "Semico Web"
        }
    }

Postman

Here’s a collection of sample queries in Postman that’ll help you get up to speed with our API faster.