API Docs

Partner API documentation page section with navigation and endpoint reference content.

API Documentation

Integrate our powerful travel insurance comparison engine directly into your platform.

Introduction

Welcome to the Compare Travel Insurance API. Our API allows partners to programmatically retrieve quotes, manage policies, and access provider data.

Note: All API requests must be made over HTTPS.

---
import ApiDocs from "@features/api-docs/ApiDocs.astro";
---

<ApiDocs />

---
blocks:
  _component: page-sections/features/api-docs
---

Overview

Use API Docs when a page should render the full developer documentation experience for partners and integration teams. This section is currently powered by a client-loaded React page with built-in navigation and fixed content, so there are no editable component inputs yet.

Properties

heading string | default: API Documentation

Main hero heading for the API docs section.

subtext string | default: Integrate our powerful travel insurance comparison engine directly into your platform.

Supporting hero description.

contentsHeading string | default: Contents

Label above the sidebar contents list.

sections array | default: array

API documentation sections shown in the editor preview.

Item Properties:

_component string | default: page-sections/features/api-docs/api-doc-section

id string | default: introduction

Unique anchor id for this section.

title string | default: Introduction

Section heading.

body string | default: Describe this API section for partners and integrators.

Main content for this section.

note string

Optional callout text.

codeBlock string

Optional code example shown in a code block.