EPISHIP API Endpoints overview

EPISHIP Endpoints API icon 32px svg

Overview

The EPISHIP API Endpoints provide comprehensive control over hardware integration and data reporting. You can develop applications that manage local print servers, automate label generation, and retrieve detailed business reports programmatically, bridging the gap between cloud-based shipping logic and physical hardware.

View Doc →

The following figure shows the relationship between your EPISHIP app, the EPISHIP API, and Hardware services.

EPISHIP Endpoints API diagram

Figure 1. EPISHIP API relationship diagram. Print server communication and report generation flow.

EPISHIP App

EPISHIP’s application layer serves as the control center for configuring physical devices. It allows administrators to define available printers, assign them to specific companies or users, and visualize data through generated reports.

EPISHIP API

The REST API that facilitates the CRUD (Create, Read, Update, Delete) operations for print servers and reports. It handles the logic for determining default printers based on user or company hierarchy.

Authentication

Secured via Bearer tokens in the Authorization header, ensuring that hardware configurations and sensitive business reports are accessible only to authenticated entities.

Print Server Management

A specialized set of endpoints designed to manage the software bridge between the API and local printers. This includes capabilities to download platform-specific software (Linux, Mac, Windows) and generate sample labels for testing.

What can users do with the EPISHIP Endpoints API?

Users can use the EPISHIP Endpoints API to perform common workflows, such as:

  • Download print server software for specific platforms (Mac, Windows, Linux)
  • Generate base64 encoded sample labels (ZPL, EPL, PNG, PDF) for testing
  • Create, update, and delete print server configurations
  • Set and clear default print servers for specific Users or Companies
  • Generate comprehensive reports based on date ranges and company IDs

Properties available to view and filter through the EPISHIP Endpoints API:

  • Print Server ID and Name
  • Platform Type (Mac/Windows/Linux)
  • Printer URL and Network Name
  • Label Format (ZPL, EPL, PNG, JPG, GIF, PDF)
  • Report Start and End Dates
  • Associated User or Company ID

Additional info

  • Learn more about developing with EPISHIP Endpoints API, including handling authentication, authorization, reference the Develop on EPISHIP API for your workspace. More →
  • Learn more about how to launch and run an EPISHIP API app, read the Developer Page. More →

Related

Related Categories