Quick Start

Generate PDF from URL POST GET

                            curl --request GET --url https://pdfmatrix.com/api/v1/get \
    ? api_token = [your api token] \
    & url = https://google.com


                            

Generate PDF from HTML POST

                            curl --request POST --url https://pdfmatrix.com/api/v1/get \
    ? api_token = [your api token] \
    & html = '<strong>Hello</strong>'



                            

Laravel SDK

Installation instructions and usage examples on github:
https://github.com/gdinko/pdfmatrix-sdk

Authentication

With each API call, you must provide an authentication token. To get your token please refer to your user account dashboard.

Provide the token as an api_token querystring parameter.

                            
https://pdfmatrix.com/api/v1/get?api_token={TOKEN}
                            
                            

Response Options

Parameter	Description	Options	Default
return	By default, the API returns JSON response. It is possible to receive the raw document using return: pdf parameter or return: download to receive pdf stream. If you want the file to be saved for 30 days in the cloud use return: storage_link, the API will return JSON response with link for download, valid 30 days or until the file is deleted by the user.	json pdf download storage_link	json
returnParams	Returns request parameters in response.	true false	false
returnScreenshot	Returns pdf and screenshot in png format with response. *this will slow down the process *only with return=json	true false	false

Example JSON Response.

                            {
    "startTime":"2019-12-19 20:21:05",
    "status":200,
    "code":200,
    "error":"",
    "pdf":"base64 encoded pdf",
    "screenShot":"base64 encoded screenshot in png format",
    "plan_limit":100,
    "remaining_limit":70,
    "endTime":"2019-12-19 20:21:12",
    "allTimeSeconds":7.1029908657073975.
    "storage_link":"link for download"
    "storage_file_name":"Storage file name"
    "storage_file_id":"Storage file ID"
    "hash":"File hash"
}
                            

Parameter	Description
startTime	Start time of the request.
status	Status code of the API request. If successful status = 200.
code	Status code of the API request operation. 200 Success 404 Missing url or hrml param 405 Element not Found 406 Could Not Take Screenshot 407 Process Failed 408 Wrong parameters 409 Quota problem
error	If code is 4XX - Description of the error.
pdf	base64 endcoded pdf data.
screenShot	*optional base64 endcoded screenshot in png format.
plan_limit	Current subscription plan maximum API Calls.
remaining_limit	Remaining API Calls.
endTime	End time of the request.
allTimeSeconds	All time of the request in seconds.
storage_link	*optional Download link valid 30 Days or until the file is deleted by the user.
storage_file_name	*optional Storage file name.
storage_file_id	*optional Storage file ID.
hash	*optional File hash.

Endpoint

Endpoint

Example JSON Response.

                            {
  "status": 200,
  "code": 200,
  "result": [
    {
      "id": 6,
      "user_id": 1,
      "file_name": "pdfmatrix_1578993957.pdf",
      "store_until": "2020-02-14",
      "url": "https:\/\/pdfmatrix.com",
      "html": "",
      "download_link": "https:\/\/pdfmatrix.com\/api\/v1\/getfile\/[HASH]",
      "hash": "[HASH]",
      "created_at": "2020-01-14 09:26:05",
      "updated_at": "2020-01-14 09:26:05"
    },
    {
      "id": 5,
      "user_id": 1,
      "file_name": "pdfmatrix_1578993957.pdf",
      "store_until": "2020-02-14",
      "url": "https:\/\/pdfmatrix.com",
      "html": "",
      "download_link": "https:\/\/pdfmatrix.com\/api\/v1\/getfile\/[HASH]",
      "hash": "[HASH]",
      "created_at": "2020-01-14 09:26:05",
      "updated_at": "2020-01-14 09:26:05"
    }
  ]
}
                            

Endpoint

Response: PDF Stream or JSON with error message:

                            {
  "status": 200,
  "code": 404,
  "message": "File is missing."
}
                            

Endpoint

Response: JSON with status code / message:

                            {
  "status": 200,
  "code": 404,
  "message": "File is missing."
}
                            

                            {
  "status": 200,
  "code": 200
}

Endpoint

Response: JSON user information:

{
  "id": 1,
  "name": "[NAME]",
  "email": "[MAIL]",
  "api_token": "[TOKEN]",
  "created_at": "",
  "updated_at": "",
  "plan_limit": 100,
  "remaining_limit": 100,
  "due_date": ""
}