Pdf Write String

POST https://api.pdfbroker.io/api/pdf/pdfwritestring

This api request is for adding text to existing pdf document.

Options

These are the options available when writing text on your existing pdf documents

Option	Description
text	The text to write in the pdf
textColor	Set the color of the text, defaults to black, rgb(0,0,0) formatted as object with properties r,g anb b, see example below
font	Set the font to style the text, formatted as an object with name, size and style: 0 = Normal, 1 = Bold, 2 = Italic, 3 = Bold and Italic, see example below
pageNumber	Set which page of pdf document to write text on. Default is 1
xPosition	Set the X axis position on where to write text, in reference to xOrigin.
yPosition	Set the Y axis position on where to write text, in reference to YOrigin.
xOrigin	Set the point from where the X axis position should be calculated from. Default value is from left side of page. 0 = Left, 1 = Center, 2 = Right
yOrigin	Set the point from where the Y axis position should be calculated from. Default value is from top of page, 0 = Top, 1 = Center, 2 = Bottom

Example of writing a string 140px left of the center of the document

{
    "pdfFileBase64String": "PD94bWwgdmVyc2lvbj0iMS4wI...shortened for readability",
    "options": {
        "text": "This is test string",
        "textColor": {
            "r": 255,
            "g": 34,
            "b": 55
        },
        "font": {
            "name": "Arial",
            "size": 24.0,
            "style": 2
        },
        "pageNumber": 1,
        "xPosition": -140.0,
        "yPosition": 0.0,
        "xOrigin": 1,
        "yOrigin": 1
    },
    "fontFileBase64String": "<If necessary you can attach your own TrueType font file.>"
}

Example of request with data formatted as application/form-data, writing a string 140px left of the center of the document.

----------------------------420442405519228210203448
Content-Disposition: form-data; name="pdfdocument"; filename="diploma.pdf"
Content-Type: application/pdf

<PDF file content removed for readability>

----------------------------420442405519228210203448
 Content-Disposition: form-data; name="options"

 {
    "text": "This is test string",
    "textColor": {
        "r": 255,
        "g": 34,
        "b": 55
    },
    "font": {
        "name": "Arial",
        "size": 24.0,
        "style": 2
    },
    "pageNumber": 1,
    "xPosition": -140.0,
    "yPosition": 0.0,
    "xOrigin": 1,
    "yOrigin": 1
}
----------------------------420442405519228210203448--

Checkout Swagger documentation

Demo

You can watch a demo of a request to our Pdf Write String api on /demo/pdf-write-text-demo

Pdf Write String

Options

Example

Demo

Feedback