OpenAPI: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
# OpenAPI API | |||
## 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. | |||
## 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. | |||
## Authentication | |||
The API key can be provided in any of these ways: | |||
### Query Parameter | |||
openapi.php/extensions?tenant=TENANTCODE&key=APIKEY | |||
### Header | |||
X-API-Key: APIKEY | |||
### Bearer Token | |||
Revision as of 07:34, 25 May 2026
- OpenAPI API
## 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.
## 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.
## Authentication
The API key can be provided in any of these ways:
### Query Parameter
openapi.php/extensions?tenant=TENANTCODE&key=APIKEY
### Header
X-API-Key: APIKEY
### Bearer Token