Every Blueport API.

PDF2JSON Public

PDF in, clean JSON out. Semantic extraction of invoices, contracts and forms with typed values and grouped entities, and no templates to maintain.

Endpoints

Request

Send the PDF one of two ways (multipart uploads are not accepted, and the limit is 8 MB):

# 1. raw PDF body
curl https://api.blueport.io/v1/pdf2json \
  -H "x-api-key: $BLUEPORT_KEY" \
  -H "content-type: application/pdf" \
  --data-binary @invoice.pdf

# 2. JSON with a base64 PDF
curl https://api.blueport.io/v1/pdf2json \
  -H "x-api-key: $BLUEPORT_KEY" \
  -H "content-type: application/json" \
  -d '{"pdf": "JVBERi0xLjQK...", "document_type": "vehicle_tax_invoice"}'

Built-in profiles: vehicle_sale_contract, vehicle_tax_invoice, nsw_form7_dealer_notice, nsw_registration_application, generic_document.

Response

{
  "ok": true,
  "data": { /* extracted fields, in the profile's shape */ },
  "meta": {
    "request_id": "req_…", "duration_ms": 5210,
    "pages": 2, "billed_units": 1, "credits": 10,
    "document_type": "vehicle_tax_invoice", "profile_version": 2,
    "warnings": []
  }
}

Errors

Billing

1 billed unit = one document of up to 5 pages (a 12-page PDF is 3 units). Each unit is 10 credits. Failed calls bill 0.

HTML2PDF Public

HTML in, pixel-perfect PDF out, rendered by a real browser engine. Send raw HTML, an inline template with data, or the id of a stored template.

Endpoints

Three ways to render

# 1. raw HTML
curl https://api.blueport.io/v1/html2pdf \
  -H "x-api-key: $BLUEPORT_KEY" -H "content-type: text/html" \
  --data-binary @statement.html -o statement.pdf

# 2. inline template + data (Handlebars)
-d '{"html": "<h1>Hi {{name}}</h1>", "data": {"name": "Sam"}, "options": {"size": "A4"}}'

# 3. stored template
-d '{"template_id": "tpl_…", "template_version": 3, "data": {…}}'

html and template_id cannot be sent together. Templates support the helpers formatCurrency and formatDate.

Options

Response

By default you get the PDF bytes, with headers x-request-id, x-pages, x-billed-units and x-credits. Add ?output=base64 (or "output": "base64") for JSON:

{ "ok": true,
  "data": { "pdf": "JVBERi0…", "pages": 3, "filename": "statement.pdf" },
  "meta": { "request_id": "req_…", "pages": 3, "billed_units": 1, "credits": 1 } }

Errors

Billing

1 billed unit = one render of up to 20 pages. Each unit is 1 credit. Previews, template management and failed renders are free.

VECTOR Tracker

VECTOR turns website behaviour into affinities and next-best actions in Salesforce. The public integration is the browser tracker. Affinities, actions and the Salesforce sync are configured in the portal at app.blueport.io, not through an API.

Install

Paste this before </body> on every page. Your site key (vk_…) is on the VECTOR setup screen in the portal.

<script>window.BlueportVector = { k: "vk_your_site_key" };</script>
<script async src="https://app.blueport.io/v.js"></script>

Page views are tracked automatically. From your own code:

BlueportVector.track("brochure_download");   // custom event
BlueportVector.identify("sam@example.com"); // link the visitor to a known contact

Endpoints

Email archive (MAS) Enterprise

Every email sent from Marketing Cloud is archived as a PDF against the subscriber. Your systems (a contact centre, a customer portal) can list a subscriber's archived emails and fetch each PDF. Your client_id and client_secret are issued when the archive is set up for you.

Endpoints

1. Get a token

curl https://mas.blueport.io/auth \
  -H "content-type: application/json" \
  -d '{"client_id": "…", "client_secret": "…"}'

{ "access_token": "eyJ…", "expires_in": 3600 }

Tokens last one hour. Send them as Authorization: Bearer <token>.

2. List a subscriber's emails

curl "https://mas.blueport.io/files/subscriber/0035g00000AbCdE?page_size=50" \
  -H "Authorization: Bearer $TOKEN"

{ "items": [ { "bp_file_key": "…", "bp_date_sent": "2026-10-14T09:12:00Z",
               "bp_signed_url": "https://…", "mc_*": "send attributes…" } ],
  "next": "…" }

Paging: page_num and page_size (default 1000); follow next / prev. bp_signed_url is a short-lived direct download link.

Errors

Archiving itself needs no code from you: Blueport connects your Marketing Cloud account to the archive during onboarding.

PURL Enterprise

Personalised short links for Marketing Cloud sends, on purl.id or your own branded domain. Each subscriber gets a stable short link per long URL, so clicks are attributed to the person. Your domain and API key are issued during onboarding.

Endpoint

All inputs are sent as request headers, which suits AMPscript HTTPPost:

curl -X POST https://api.purl.id/v1/shorten \
  -H "domain: go.example.com" -H "api_key: $PURL_KEY" \
  -H "long_url: https://example.com/offer" -H "subscriber_key: 0035g00000AbCdE"

https://go.example.com/aB3dE9x

The response is the short URL as plain text. The same long_url and subscriber_key always return the same link.

Errors

Products without a public API Portal & managed

Need programmatic access to any of these? Tell us what you are building.