The Share A Refund Shortlinks API lets you create and view shortened URLs that are used for sharing tracking information, proof of delivery documents, and reports. You can develop applications that integrate with Share A Refund to automate the distribution of long, complex URLs into manageable, shareable links.

The following figure shows the relationship between your Share A Refund app, the Share A Refund API, and Shortlinks.

Shortlinks API diagram svg

Figure 1. Share A Refund API relationship diagram.

Share A Refund App

Share A Refund’s shortlinks services gives users the ability to generate clean, trackable links for shipments, proof of delivery documents, and analytics reports, to ensure secure and professional sharing of information.

Share A Refund API

The REST API that allows users to generate and manage Shortlinks from within your app.

Authentication

An app that uses Share A Refund Shortlinks as a secure method to distribute content, manage access, expiration and tracking engagement from within your app.

Link Management

A location that maintains all active shortlinks, their original destinations, expiration status, and click-through analytics from inside any given campaign.

What can users do with the Share A Refund Shortlinks API?

Users can use the Share A Refund Shortlinks to perform common workflows, such as:

  • Create a new shortlink from a long URL
  • Delete or deactivate an existing shortlink
  • Integrate shortlink generation into customer support notifications
  • Monitor click counts and engagement analytics
  • Set expiration dates for time-sensitive documents
  • Update the destination URL of an active shortlink



Shortlink properties available to create, modify, update and delete through the Share A Refund Shortlinks API:

  • Active Status
  • Campaign Tracking
  • Expiration Date
  • Link Analysis
  • Personalized Slugs

Additional info

Learn more about developing with Share A Refund Shortlinks API, including handling authentication, authorization, reference the Develop on Share A Refund API for your workspace. More

Learn more about how to launch and run a Share A Refund Shortlinks API app, read the Developer Getting Started Guide. More