Skip to main content
Short answer: In ShortPen, the API lets you automate link creation, manage analytics, and connect with other tools programmatically, saving time and enabling complex workflows that go beyond the web interface.

​
What an API does

An API acts as a bridge between applications. With it, developers can:
  • Automate operations: create, update, or delete data (like links or campaigns).
  • Retrieve analytics: feed reporting dashboards, CRMs, or BI tools.
  • Send or receive events: record conversions, trigger workflows, or respond to external updates.
  • Build integrations: connect ShortPen with other platforms (e.g., Make, Zapier, etc.).
Think of an API as a set of building blocks that let different systems “talk” using predictable rules and secure authentication.

​
When and why to use APIs

Use APIs when you want to:
  1. Scale repetitive tasks (e.g., automate link creation from a CMS or e-commerce store).
  2. Integrate systems (e.g., sync click data into Google Sheets or a BI tool).
  3. Enhance workflows (e.g., trigger events after specific actions in your product).
  4. Build new experiences (e.g., your own custom dashboard powered by ShortPen data).
APIs unlock efficiency and consistency, especially when you manage large-scale or data-driven workflows.

​
How APIs work

When you make an API request, your app sends a message to ShortPen’s servers, often using HTTPS. Each request includes:
  • A URL endpoint (the resource you want to access, like /links or /analytics).
  • A method (e.g., GET to read, POST to create).
  • Headers and authentication (your secure credentials).
The server processes your request and sends back a structured JSON response, which your system can interpret and act on.
See also: API Reference

​
Common Use Cases

Use CaseExample
Automating link creationGenerate tracking links directly from your CMS or store
ReportingSync link performance data to a BI dashboard
Event trackingSend post-purchase events from your backend
IntegrationConnect ShortPen to workflow tools like Make or Zapier

​
FAQ

An API lets one program talk to another automatically. It defines how they exchange information and perform actions securely.
Typically, yes. APIs are designed for developers. However, tools like Zapier or Make use the API for you through no-code integrations.
API access and webhooks are available on paid plans. If you downgrade to Free, API calls stop but your data remains safe.
An API lets your system request data or perform actions. A webhook sends data to you automatically when an event happens.