EPISHIP API Websites and Branding overview

EPISHIP Websites and Branding API icon 32px svg

Overview

The EPISHIP Websites & Branding API empowers you to programmatically customize the visual identity and configuration of your shipping portals. You can develop applications that manage white-label settings, allowing you to dynamically update logos, theme colors, and email sender identities to match your corporate branding across different reseller instances.

 

View Doc →

 

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

EPISHIP Websites and Branding API diagram

Figure 1. EPISHIP API relationship diagram. Asset management and theme configuration flow.

EPISHIP App

EPISHIP’s branding interface serves as the design control center for your shipping portal. Administrators can upload specific assets (favicons, app bar logos), define primary theme colors, and configure domain-specific settings to ensure a seamless brand experience for end-users.

EPISHIP API

The REST API that manages website resources. It supports operations to retrieve the current website’s configuration, look up websites by their domain code, and update visual elements. It also handles the validation of branding information before saving to prevent configuration errors.

Authentication

Secured via Bearer tokens in the Authorization header. Access to website settings is scoped to the specific Company ID, allowing resellers to manage the branding of their child companies without interfering with other tenants.

What can users do with the EPISHIP Websites API?

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

  • Retrieve the active website configuration, including all logo URLs and color codes
  • Look up specific website details using a domain code (e.g., `ship.example.com`)
  • Update branding assets such as logos, favicons, and app bar images
  • Configure functional settings like enabling or disabling user registration
  • Soft-delete and restore website configurations to manage lifecycle

Website properties available to view and filter through the EPISHIP Websites API:

  • Website Code (Domain/Host)
  • Theme Color (Hex)
  • Asset URLs (Logo, Favicon, App Bar Logo)
  • Email Sender Address
  • Registration Settings
  • Associated Company ID

Additional info

  • Learn more about developing with EPISHIP Websites 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 Websites API app, read the Developer Page. More →

Related

Related Categories