AdminGuide:RestAPI/en - Cronologia

Troccoli il 08:45, 17 feb 2022

2022-02-17T08:45:51Z

← Versione meno recente		Versione delle 08:45, 17 feb 2022
Riga 3:		Riga 3:
	<div class="noutonum" style="float: right">__TOC__</div>		<div class="noutonum" style="float: right">__TOC__</div>

	~~<div class="mw-translate-fuzzy">~~
	== General description ==		== General description ==
	KalliopePBX offers several REST APIs that can be invoked by external systems to execute device actions (e.g. creating extensions, generating and downloading backups, etc.) or consultation actions (e.g. downloading the CDR, etc.).		KalliopePBX offers several REST APIs that can be invoked by external systems to execute device actions (e.g. creating extensions, generating and downloading backups, etc.) or consultation actions (e.g. downloading the CDR, etc.).
	~~</div>~~

	APIs can be accessed through HTTP or HTTPS with authentication, following the mechanism described below.		APIs can be accessed through HTTP or HTTPS with authentication, following the mechanism described below.

Troccoli: Creata pagina con "where the string , in the case of a single tenant machine, is "default". In the case of multi-tenant system, in order to use the API available to pbxadmin, it..."

2022-02-15T15:08:35Z

Creata pagina con "where the string <dominio_tenant>, in the case of a single tenant machine, is "default". In the case of multi-tenant system, in order to use the API available to pbxadmin, it..."

← Versione meno recente		Versione delle 15:08, 15 feb 2022
Riga 39:		Riga 39:
	rest/salt/<dominio_tenant>		rest/salt/<dominio_tenant>

	~~dove la stringa~~ <dominio_tenant> ,~~nel caso di macchina~~ single tenant, ~~vale~~ "default". ~~Nel caso di sistema~~ multi-tenant, ~~per poter utilizzare le~~ API ~~a disposizione di~~ pbxadmin, ~~è possibile ottenere il~~ salt ~~relativo mediante l'~~API		where the string <dominio_tenant>, in the case of a single tenant machine, is "default". In the case of multi-tenant system, in order to use the API available to pbxadmin, it is possible to obtain the relative salt through the API

	rest/salt/pbxAdmin		rest/salt/pbxAdmin

Troccoli: Creata pagina con "
"

2022-02-15T14:50:43Z

Creata pagina con "<br>"

← Versione meno recente		Versione delle 14:50, 15 feb 2022
Riga 108:		Riga 108:
	Starting from firmware version '''4.9.4''' it is also available a '''Postman collection''' (that replaces the sandbox integrated in the documentation page); this collection integrates the code to automatically add the required authentication header (it is necessary only to set the IP address of the PBX and the username/password credentials of the user to invoke the API).		Starting from firmware version '''4.9.4''' it is also available a '''Postman collection''' (that replaces the sandbox integrated in the documentation page); this collection integrates the code to automatically add the required authentication header (it is necessary only to set the IP address of the PBX and the username/password credentials of the user to invoke the API).

	~~Accedendo alla '''KalliopeTribe''' è disponibile un video che mostra l'utilizzo di tale collection per invocare in modo rapido le API di Kalliope.~~		<br>

	The collection file can be downloaded from these links:<br>		The collection file can be downloaded from these links:<br>

Troccoli il 14:47, 15 feb 2022

2022-02-15T14:47:09Z

← Versione meno recente		Versione delle 14:47, 15 feb 2022
Riga 71:		Riga 71:
	X-authenticate: RestApiUsernameToken Username="admin", Domain="default", Digest="+PJg7Tb3v98XnL6iJVv+v5hwhYjdzQ2tIWxvJB2cE40=", Nonce="bfb79078ff44c35714af28b7412a702b", Created="2016-04-29T15:48:26Z"		X-authenticate: RestApiUsernameToken Username="admin", Domain="default", Digest="+PJg7Tb3v98XnL6iJVv+v5hwhYjdzQ2tIWxvJB2cE40=", Nonce="bfb79078ff44c35714af28b7412a702b", Created="2016-04-29T15:48:26Z"

	~~<div class="mw-translate-fuzzy">~~
	== API list ==		== API list ==
	<!--		<!--
Riga 103:		Riga 102:
	\|}		\|}
	-->		-->
	For firmware versions up to 4.8.x, the updated API list can be viewed at ~~'''http://''kalliope_ip_address''/api/doc'''~~		For firmware versions up to 4.8.x, the updated API list can be viewed at
	~~</div>~~

	http[s]://''KALLIOPE_IP_ADDRESS''/api/doc		http[s]://''KALLIOPE_IP_ADDRESS''/api/doc
Riga 112:		Riga 110:
	Accedendo alla '''KalliopeTribe''' è disponibile un video che mostra l'utilizzo di tale collection per invocare in modo rapido le API di Kalliope.		Accedendo alla '''KalliopeTribe''' è disponibile un video che mostra l'utilizzo di tale collection per invocare in modo rapido le API di Kalliope.

	The collection file can be downloaded from ~~this~~ [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip ~~link~~].		The collection file can be downloaded from these links:<br>
			* [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip Collection Postman for firmware 4.9.4 - 4.9.8]
			* [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.9.postman_collection.json.zip Collection Postman for firmware 4.9.9 or superior]
			* [https://www.kalliopepbx.com/wiki/Hotel%20API%204.9.9.postman_collection.zip Collection Postman for Hotel Module, firmware 4.9.9 or superior]
			* [http://www.kalliopepbx.com/wiki/KalliopeLAM.postman_collection_4_11_3.zip Collection Postman for KalliopeLAM, firmware 4.11.3 or superior]

	You can download the file with API swagger specification from KalliopePBX, here:<br>		You can download the file with API swagger specification from KalliopePBX, here:<br>
Riga 118:		Riga 120:
	http[s]://''KALLIOPE_IP_ADDRESS''/api/doc.json		http[s]://''KALLIOPE_IP_ADDRESS''/api/doc.json

	== ~~Manuale per le~~ API ~~relative al CDR~~ ==		== Guide for CDR-related API ==
	~~Dal momento che le~~ API ~~relative al CDR sono le più comunemente utilizzate abbiamo realizzato un semplice documento di approfondimento su questa famiglia di~~ API.<br>		Since CDR-related API are the most common, we created a document about this family of API.<br>
	~~E' possibile scaricare il documento da questo~~ [https://www.kalliope.com/download/manuale-api-rest-cdr-v4/?wpdmdl=2100&masterkey link].		You can download it from this [https://www.kalliope.com/download/manuale-api-rest-cdr-v4/?wpdmdl=2100&masterkey link].

	== Classes for generating authentication headers ==		== Classes for generating authentication headers ==

Troccoli: Creata pagina con " http[s]://''KALLIOPE_IP_ADDRESS''/api/doc.json"

2022-02-15T14:37:54Z

Creata pagina con " http[s]://''KALLIOPE_IP_ADDRESS''/api/doc.json"

← Versione meno recente		Versione delle 14:37, 15 feb 2022
Riga 35:		Riga 35:
	Since KalliopePBX saves passwords in the form of non-reversible hashes, the digest must be generated using the hash of the password obtained using the same method as KalliopePBX ('''digestPassword''').		Since KalliopePBX saves passwords in the form of non-reversible hashes, the digest must be generated using the hash of the password obtained using the same method as KalliopePBX ('''digestPassword''').

	~~<div class="mw-translate-fuzzy">~~		The hash function that produces the digestPassword requires the user password and a '''salt''' string, which is unique for each tenant. The salt can be obtained from KalliopePBX with a designated REST API that can be invoked anonymously (i.e. without authentication):
	The hash function that produces the digestPassword requires the user password and a '''salt''' string, which is unique for each tenant. The salt can be obtained from KalliopePBX with a designated REST API that can be invoked anonymously (i.e. without authentication).
	~~</div>~~

	rest/salt/<dominio_tenant>		rest/salt/<dominio_tenant>
Riga 110:		Riga 108:
	http[s]://''KALLIOPE_IP_ADDRESS''/api/doc		http[s]://''KALLIOPE_IP_ADDRESS''/api/doc

	~~<div class="mw-translate-fuzzy">~~		Starting from firmware version '''4.9.4''' it is also available a '''Postman collection''' (that replaces the sandbox integrated in the documentation page); this collection integrates the code to automatically add the required authentication header (it is necessary only to set the IP address of the PBX and the username/password credentials of the user to invoke the API).
	Starting from firmware version '''4.9.4'''~~, there~~ is available a '''Postman collection''' that integrates the code ~~for~~ automatically ~~adding~~ the required authentication header (it is only ~~necessary~~ to set the IP address of the PBX and the username/password credentials of the user ~~with which you wish~~ to invoke the API).
			Accedendo alla '''KalliopeTribe''' è disponibile un video che mostra l'utilizzo di tale collection per invocare in modo rapido le API di Kalliope.

	The collection file can be downloaded from this [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip link].		The collection file can be downloaded from this [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip link].

	You can download the file with API swagger specification from KalliopePBX, here:<br>		You can download the file with API swagger specification from KalliopePBX, here:<br>
	~~http[s]://''KALLIOPE_IP_ADDRESS''/api/doc.json~~
	~~</div>~~

	~~Accedendo alla '''KalliopeTribe''' è disponibile un video che mostra l'utilizzo di tale collection per invocare in modo rapido le API di Kalliope.~~

	~~E' possibile scaricare il file di collection per le varie versioni firmware dai seguenti link:<br>~~
	* [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip Collection Postman per firmware 4.9.4 - 4.9.8]
	* [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.9.postman_collection.json.zip Collection Postman per firmware 4.9.9 o superiori]
	* [https://www.kalliopepbx.com/wiki/Hotel%20API%204.9.9.postman_collection.zip Collection Postman per Modulo Hotel, firmware 4.9.9 o superiori]
	* [http://www.kalliopepbx.com/wiki/KalliopeLAM.postman_collection_4_11_3.zip Collection Postman per KalliopeLAM, firmware 4.11.3 o superiori]

	~~E' inoltre disponibile il file con la specifica swagger delle API, sempre scaricabile dal KalliopePBX, all'indirizzo:~~

	http[s]://''KALLIOPE_IP_ADDRESS''/api/doc.json		http[s]://''KALLIOPE_IP_ADDRESS''/api/doc.json

	== Manuale per le API relative al CDR ==		== Manuale per le API relative al CDR ==

FuzzyBot: Aggiornamento come da nuova versione della pagina di origine

2022-02-15T13:45:41Z

Aggiornamento come da nuova versione della pagina di origine

← Versione meno recente		Versione delle 13:45, 15 feb 2022
Riga 3:		Riga 3:
	<div class="noutonum" style="float: right">__TOC__</div>		<div class="noutonum" style="float: right">__TOC__</div>

			<div class="mw-translate-fuzzy">
	== General description ==		== General description ==
	KalliopePBX offers several REST APIs that can be invoked by external systems to execute device actions (e.g. creating extensions, generating and downloading backups, etc.) or consultation actions (e.g. downloading the CDR, etc.).		KalliopePBX offers several REST APIs that can be invoked by external systems to execute device actions (e.g. creating extensions, generating and downloading backups, etc.) or consultation actions (e.g. downloading the CDR, etc.).
			</div>

	APIs can be accessed through HTTP or HTTPS with authentication, following the mechanism described below.		APIs can be accessed through HTTP or HTTPS with authentication, following the mechanism described below.
Riga 34:		Riga 35:
	Since KalliopePBX saves passwords in the form of non-reversible hashes, the digest must be generated using the hash of the password obtained using the same method as KalliopePBX ('''digestPassword''').		Since KalliopePBX saves passwords in the form of non-reversible hashes, the digest must be generated using the hash of the password obtained using the same method as KalliopePBX ('''digestPassword''').

			<div class="mw-translate-fuzzy">
	The hash function that produces the digestPassword requires the user password and a '''salt''' string, which is unique for each tenant. The salt can be obtained from KalliopePBX with a designated REST API that can be invoked anonymously (i.e. without authentication).		The hash function that produces the digestPassword requires the user password and a '''salt''' string, which is unique for each tenant. The salt can be obtained from KalliopePBX with a designated REST API that can be invoked anonymously (i.e. without authentication).
			</div>

			rest/salt/<dominio_tenant>

			dove la stringa <dominio_tenant> ,nel caso di macchina single tenant, vale "default". Nel caso di sistema multi-tenant, per poter utilizzare le API a disposizione di pbxadmin, è possibile ottenere il salt relativo mediante l'API

			rest/salt/pbxAdmin

	The formula is as follows (the { e } characters are part of the string to which SHA-256 is applied and must be inserted):		The formula is as follows (the { e } characters are part of the string to which SHA-256 is applied and must be inserted):
Riga 64:		Riga 73:
	X-authenticate: RestApiUsernameToken Username="admin", Domain="default", Digest="+PJg7Tb3v98XnL6iJVv+v5hwhYjdzQ2tIWxvJB2cE40=", Nonce="bfb79078ff44c35714af28b7412a702b", Created="2016-04-29T15:48:26Z"		X-authenticate: RestApiUsernameToken Username="admin", Domain="default", Digest="+PJg7Tb3v98XnL6iJVv+v5hwhYjdzQ2tIWxvJB2cE40=", Nonce="bfb79078ff44c35714af28b7412a702b", Created="2016-04-29T15:48:26Z"

			<div class="mw-translate-fuzzy">
	== API list ==		== API list ==
	<!--		<!--
Riga 95:		Riga 105:
	\|}		\|}
	-->		-->
	For firmware versions up to 4.8.x, the updated API list can be viewed at '''http://''kalliope_ip_address''/api/doc'''		For firmware versions up to 4.8.x, the updated API list can be viewed at '''http://''kalliope_ip_address''/api/doc'''
			</div>

			http[s]://''KALLIOPE_IP_ADDRESS''/api/doc

			<div class="mw-translate-fuzzy">
	Starting from firmware version '''4.9.4''', there is available a '''Postman collection''' that integrates the code for automatically adding the required authentication header (it is only necessary to set the IP address of the PBX and the username/password credentials of the user with which you wish to invoke the API).		Starting from firmware version '''4.9.4''', there is available a '''Postman collection''' that integrates the code for automatically adding the required authentication header (it is only necessary to set the IP address of the PBX and the username/password credentials of the user with which you wish to invoke the API).

Riga 103:		Riga 117:
	You can download the file with API swagger specification from KalliopePBX, here:<br>		You can download the file with API swagger specification from KalliopePBX, here:<br>
	http[s]://''KALLIOPE_IP_ADDRESS''/api/doc.json		http[s]://''KALLIOPE_IP_ADDRESS''/api/doc.json
			</div>

			Accedendo alla '''KalliopeTribe''' è disponibile un video che mostra l'utilizzo di tale collection per invocare in modo rapido le API di Kalliope.

			E' possibile scaricare il file di collection per le varie versioni firmware dai seguenti link:<br>
			* [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip Collection Postman per firmware 4.9.4 - 4.9.8]
			* [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.9.postman_collection.json.zip Collection Postman per firmware 4.9.9 o superiori]
			* [https://www.kalliopepbx.com/wiki/Hotel%20API%204.9.9.postman_collection.zip Collection Postman per Modulo Hotel, firmware 4.9.9 o superiori]
			* [http://www.kalliopepbx.com/wiki/KalliopeLAM.postman_collection_4_11_3.zip Collection Postman per KalliopeLAM, firmware 4.11.3 o superiori]

			E' inoltre disponibile il file con la specifica swagger delle API, sempre scaricabile dal KalliopePBX, all'indirizzo:

			http[s]://''KALLIOPE_IP_ADDRESS''/api/doc.json

			== Manuale per le API relative al CDR ==
			Dal momento che le API relative al CDR sono le più comunemente utilizzate abbiamo realizzato un semplice documento di approfondimento su questa famiglia di API.<br>
			E' possibile scaricare il documento da questo [https://www.kalliope.com/download/manuale-api-rest-cdr-v4/?wpdmdl=2100&masterkey link].

	== Classes for generating authentication headers ==		== Classes for generating authentication headers ==

Troccoli il 16:38, 11 feb 2022

2022-02-11T16:38:59Z

← Versione meno recente		Versione delle 16:38, 11 feb 2022
Riga 100:		Riga 100:

	The collection file can be downloaded from this [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip link].		The collection file can be downloaded from this [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip link].

			You can download the file with API swagger specification from KalliopePBX, here:<br>
			http[s]://''KALLIOPE_IP_ADDRESS''/api/doc.json

	== Classes for generating authentication headers ==		== Classes for generating authentication headers ==

S.vistoli il 07:58, 16 mar 2020

2020-03-16T07:58:31Z

← Versione meno recente		Versione delle 07:58, 16 mar 2020
Riga 99:		Riga 99:
	Starting from firmware version '''4.9.4''', there is available a '''Postman collection''' that integrates the code for automatically adding the required authentication header (it is only necessary to set the IP address of the PBX and the username/password credentials of the user with which you wish to invoke the API).		Starting from firmware version '''4.9.4''', there is available a '''Postman collection''' that integrates the code for automatically adding the required authentication header (it is only necessary to set the IP address of the PBX and the username/password credentials of the user with which you wish to invoke the API).

	~~THe~~ collection file can be downloaded from this [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip link].		The collection file can be downloaded from this [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip link].

	== Classes for generating authentication headers ==		== Classes for generating authentication headers ==

S.vistoli il 08:12, 12 mar 2020

2020-03-12T08:12:07Z

← Versione meno recente		Versione delle 08:12, 12 mar 2020
Riga 97:		Riga 97:
	For firmware versions up to 4.8.x, the updated API list can be viewed at '''http://''kalliope_ip_address''/api/doc'''		For firmware versions up to 4.8.x, the updated API list can be viewed at '''http://''kalliope_ip_address''/api/doc'''

	Starting from firmware version '''4.9.4''', there is available a ''' ~~ìPostman~~ collection''' that integrates the code for automatically adding the required authentication header (it is only necessary to set the IP address of the PBX and the username/password credentials of the user with which you wish to invoke the API).		Starting from firmware version '''4.9.4''', there is available a '''Postman collection''' that integrates the code for automatically adding the required authentication header (it is only necessary to set the IP address of the PBX and the username/password credentials of the user with which you wish to invoke the API).

	THe collection file can be downloaded from this [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip link].		THe collection file can be downloaded from this [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip link].

S.vistoli: Creata pagina con "Starting from firmware version '''4.9.4''', there is available a ''' ìPostman collection''' that integrates the code for automatically adding the required authentication head..."

2020-03-12T08:12:01Z

Creata pagina con "Starting from firmware version '''4.9.4''', there is available a ''' ìPostman collection''' that integrates the code for automatically adding the required authentication head..."

← Versione meno recente		Versione delle 08:12, 12 mar 2020
Riga 97:		Riga 97:
	For firmware versions up to 4.8.x, the updated API list can be viewed at '''http://''kalliope_ip_address''/api/doc'''		For firmware versions up to 4.8.x, the updated API list can be viewed at '''http://''kalliope_ip_address''/api/doc'''

	~~A partire dalla versione~~ firmware '''4.9.4''' ~~è disponibile una~~ '''collection ~~Postman~~''' ~~che integra anche il codice per aggiungere automaticamente l'~~header ~~di autenticazione richiesto~~ (~~è necessario solo impostare l'indirizzo~~ IP ~~del~~ PBX ~~e le credenziali~~ username/password ~~dell'utente con cui invocare l'~~API).		Starting from firmware version '''4.9.4''', there is available a ''' ìPostman collection''' that integrates the code for automatically adding the required authentication header (it is only necessary to set the IP address of the PBX and the username/password credentials of the user with which you wish to invoke the API).
	~~E' possibile scaricare il~~ file ~~di collection da questo~~ [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip link].
			THe collection file can be downloaded from this [https://www.kalliopepbx.com/wiki/KalliopePBX%20API%204.9.4.postman_collection.json.zip link].

	== Classes for generating authentication headers ==		== Classes for generating authentication headers ==