OpenAPI: Difference between revisions

Revision as of 07:37, 25 May 2026

 openapi.php is the 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 ==

@@ Line 1: / Line 1: @@
 == Overview ==
-openapi.php is the new JSON API endpoint based on the OpenAPI specification.
+  <code>openapi.php</code> is the JSON API endpoint based on the OpenAPI specification.
-The API uses the existing MirtaPBX API keys:
+  The API uses the existing MirtaPBX API keys:
-* Full API key: APIKEY
+  * Full API key: <code>APIKEY</code>
-* Read-only API key: READONLYAPIKEY
+  * Read-only API key: <code>READONLYAPIKEY</code>
-Both global and tenant-level keys are supported.
+  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.
+  The first implemented API object is <code>extension</code>, with a list endpoint returning extension ID, number, name, and technology.
-## OpenAPI Specification
+  == 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