Skip to content

API & Reference Overview

Skeleton — content coming later

Developer documentation is planned for a later phase. This page reserves the structure so it slots in cleanly when the API is ready.

This section will hold the developer-facing documentation for Interline: how to authenticate, the available endpoints, and reference material for integrating with the platform.

Planned pages

Getting started with the API

  • Authentication and API keys
  • Base URL, versioning, and conventions
  • Rate limits and error handling

Reference

  • Messages: sending and receiving across channels
  • Conversations & mailboxes
  • Contacts, lists, and tags
  • Broadcast campaigns
  • Keywords
  • Webhooks (inbound messages, delivery status)

Guides

  • Common integration recipes
  • Migrating from the previous third-party tool

Rendering an OpenAPI spec

When the API is ready, this MkDocs site can render an interactive reference directly from an OpenAPI/Swagger file using a plugin such as mkdocs-swagger-ui-tag or neoteroi-mkdocs. See the README build notes for how to add it.