Api-Integration

How the api works

Purpose of the API

The Pixlcodr API is designed to integrate the Pixlcodr image-to-table rendering technology into external applications, i.e. mailing tools, automated e-mail systems of other automated e-mail related purposes.

Code reduction

Pixlcodr optimizes the output (HTML code) with a given reduction factor. The higher the factor, the lower the quality of the image, but the smaller the filesize of the HTML code.

The reduction factor is an argument when calling the Pixlcodr API, just like it is when you use our website.

Recommended implementation

Server-to-server communication may fail, like any other communication between to nodes on the internet. In order to let the main application (your application, that implement this API) not be affected by any form of conncection problems, we strongly recommend that the API is not implemented in any scripts or logic that are directly called by user interaction.

In case of sending an e-mail, we recommend that you prepare an e-mail, triggered by user interaction. Rendering the image to a table, by calling the API, should then not be included in this script, as it may fail and thereby affect the user experience of your application. It should be called by an automated trigger, i.e. a cronjob, that makes the connection to the API and then send the e-mail to the user.

Availability

The API is available through SOAP and REST.

Authentication

The API requires credentials, as this is a paid service.

One can submit an $apikey variable with every request. This variable is a string that should by passed on throught the headers that are sent with the request. E.g. adding the variable “apikey” to the SOAP-headers for a SOAP-request, adding it to the HTTP-headers for a REST-request.

Functions

There is currently one function available through the API.

Download the API manual

 

Supported popular program languages

  • C
  • JAVA
  • OBJ.C
  • C++
  • C#
  • PHP
  • VB
  • PYTHON
  • PERL
  • RUBY
  • ASP.NET
  • DART
 
Trusted by