OpenAPI: Difference between revisions

From MiRTA PBX documentation
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
== Overview ==
== Overview ==


  <code>openapi.php</code> is the 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: <code>APIKEY</code>
* Full API key: <code>APIKEY</code>
  * Read-only API key: <code>READONLYAPIKEY</code>
* 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 <code>extension</code>, 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 ==

Revision as of 07:37, 25 May 2026

Overview

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