2021-03-26 14:40:23 +01:00
|
|
|
<?php
|
|
|
|
|
/* Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
|
|
|
|
|
* Copyright (C) 2016 Laurent Destailleur <eldy@users.sourceforge.net>
|
2024-11-04 23:53:20 +01:00
|
|
|
* Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
|
2021-03-26 14:40:23 +01:00
|
|
|
*
|
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
|
|
|
* (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* \defgroup api Module DolibarrApi
|
|
|
|
|
* \brief API explorer using the swagger.json file
|
|
|
|
|
* \file htdocs/api/admin/explorer_withredoc.php
|
2024-03-08 21:27:09 +01:00
|
|
|
*
|
|
|
|
|
* @deprecated Old explorer. Not using Swagger. See instead explorer in htdocs/api/index.php.
|
2021-03-26 14:40:23 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
require_once '../../main.inc.php';
|
|
|
|
|
|
2024-11-04 23:53:20 +01:00
|
|
|
/**
|
|
|
|
|
* @var Conf $conf
|
|
|
|
|
* @var DoliDB $db
|
|
|
|
|
* @var HookManager $hookmanager
|
|
|
|
|
* @var Translate $langs
|
|
|
|
|
* @var User $user
|
|
|
|
|
*/
|
|
|
|
|
|
2021-03-26 14:54:12 +01:00
|
|
|
// Enable and test if module Api is enabled
|
2023-12-04 11:41:14 +01:00
|
|
|
if (!isModEnabled('api')) {
|
2021-03-26 14:54:12 +01:00
|
|
|
$langs->load("admin");
|
|
|
|
|
dol_syslog("Call of Dolibarr API interfaces with module API REST are disabled");
|
|
|
|
|
print $langs->trans("WarningModuleNotActive", 'Api').'.<br><br>';
|
|
|
|
|
print $langs->trans("ToActivateModule");
|
|
|
|
|
//session_destroy();
|
|
|
|
|
exit(0);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Test if explorer is not disabled
|
2023-10-24 17:00:13 +02:00
|
|
|
if (getDolGlobalString('API_EXPLORER_DISABLED')) {
|
2021-03-26 14:54:12 +01:00
|
|
|
$langs->load("admin");
|
|
|
|
|
dol_syslog("Call Dolibarr API interfaces with module REST disabled");
|
|
|
|
|
print $langs->trans("WarningAPIExplorerDisabled").'.<br><br>';
|
|
|
|
|
//session_destroy();
|
|
|
|
|
exit(0);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Restrict API to some IPs
|
2023-10-24 17:00:13 +02:00
|
|
|
if (getDolGlobalString('API_RESTRICT_ON_IP')) {
|
2023-12-13 15:20:53 +01:00
|
|
|
$allowedip = explode(' ', getDolGlobalString('API_RESTRICT_ON_IP'));
|
2021-03-26 14:54:12 +01:00
|
|
|
$ipremote = getUserRemoteIP();
|
|
|
|
|
if (!in_array($ipremote, $allowedip)) {
|
2023-10-15 15:32:35 +02:00
|
|
|
dol_syslog('Remote ip is '.$ipremote.', not into list ' . getDolGlobalString('API_RESTRICT_ON_IP'));
|
2021-03-26 14:54:12 +01:00
|
|
|
print 'APIs are not allowed from the IP '.$ipremote;
|
|
|
|
|
header('HTTP/1.1 503 API not allowed from your IP '.$ipremote);
|
|
|
|
|
//session_destroy();
|
|
|
|
|
exit(0);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2021-03-26 14:40:23 +01:00
|
|
|
?>
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>ReDoc</title>
|
|
|
|
|
<!-- needed for adaptive design -->
|
|
|
|
|
<meta charset="utf-8"/>
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
|
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
|
ReDoc doesn't change outer page styles
|
|
|
|
|
-->
|
|
|
|
|
<style>
|
|
|
|
|
body {
|
|
|
|
|
margin: 0;
|
|
|
|
|
padding: 0;
|
|
|
|
|
}
|
|
|
|
|
</style>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<redoc spec-url='<?php echo DOL_MAIN_URL_ROOT.'/api/index.php/explorer/swagger.json?DOLAPIKEY='.GETPOST('DOLAPIKEY', 'aZ09'); ?>'></redoc>
|
|
|
|
|
<!--<redoc spec-url='https://demo.dolibarr.org/api/index.php/explorer/swagger.json'></redoc>-->
|
|
|
|
|
<!--<redoc spec-url='http://petstore.swagger.io/v2/swagger.json'></redoc>-->
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
