Introduction

Hozip is a link management platform that lets you create, organise and track short links programmatically. Use the REST API to generate short URLs, manage groups and query the domains available on your account.

Why Hozip?

Hozip gives developers a clean API to automate short-link creation at scale. Assign links to groups for organisation, choose a specific domain (platform or custom), and filter your link inventory without touching the dashboard.

Key Concepts

  • Links: Short, trackable URLs created via the API. Each link stores its destination (long_url), a short_code, and the domain it lives on.
  • Groups: Logical containers for organising links. Every link belongs to exactly one group; if you omit group_id on creation the user's default group is used.
  • Domains: Platform-provided domains and active custom domains you have configured. Retrieve available options with the Enabled Domains endpoint before creating links.

Authentication

Use an API Key for simple, secure access. Supply it via the Authorization: Token <API_KEY> header on all requests. See the Authentication page for full setup instructions.

Main Endpoints

  • GET /api/v1/external/groups — list your groups (id and name)
  • GET /api/v1/external/links — list links with offset/limit pagination and optional long_url filtering
  • POST /api/v1/external/links/create-link — create a short link
  • GET /api/v1/external/links/enabled-domains — list platform and custom domains available on your account

Quick Examples

cURL — create a short link

curl -X POST \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"long_url":"https://example.com"}' \
  https://hozip.com/api/v1/external/links/create-link

Python (requests) — list links

import requests
resp = requests.get(
    'https://hozip.com/api/v1/external/links',
    headers={'Authorization': 'Token YOUR_API_KEY'},
    params={'limit': 20, 'offset': 0},
)
print(resp.json())

Best Practices

  • Call GET /api/v1/external/links/enabled-domains once at startup and cache the result — domain availability rarely changes.
  • Use long_url filtering (match=startswith) to look up existing links before creating duplicates.
  • Protect your API Key, rotate it periodically, and never embed it in client-side code.
  • Respect the rate limit of 100 link creations per hour. Spread bulk imports across multiple hours if needed.

Next Steps

Follow the Quick Start to create your first link, or open the API Reference for full endpoint details and example payloads.

Documentation