OpenAPI

Overview

openapi.php is the new JSON API endpoint based on the OpenAPI specification.

The API uses the existing MirtaPBX API keys:

- Full API key: APIKEY
- Read-only API key: READONLYAPIKEY

Both global and tenant-level keys are supported.

The first implemented API object is extension, with a list endpoint returning extension ID, number, name, and technology.

1. 1. OpenAPI Specification

The OpenAPI specification is available from:

openapi.php openapi.php?spec=1 openapi.php/openapi.json openapi.php/swagger.json

The response is an OpenAPI 3.0.3 JSON document.

1. 1. Authentication

The API key can be provided in any of these ways:

1. 1. 1. Query Parameter

openapi.php/extensions?tenant=TENANTCODE&key=APIKEY

1. 1. 1. Header

X-API-Key: APIKEY

1. 1. 1. Bearer Token