版本：5.1

Web 服务

Web 服务概念的描述

Web 服务用于使系统通过使用 HTTP 协议（如今通过 TLS（传输层安全））互相通信。
另一个定义可能是 Web 服务充当生产者和消费者通过端点之间的合同。
简而言之，Web 服务就像房屋的门窗一样，它们是通往外部世界的输入和输出。
在 Joomla! 作为系统的背景下，Joomla Web 服务 API 允许 Joomla! 与外部数据源交互。比如网络应用、移动应用等…

与 Joomla 4.x Web 服务 API 通信

与 Joomla 的 Web 服务 API 的通信通过指定的端点进行。

Joomla 的核心端点：https://docs.joomla.org/J4.x:Joomla_Core_APIs
在 Postman 中使用的 Joomla 端点集合：https://github.com/alexandreelise/j4x-api-collection

使用 Joomla 框架

在使用 Joomla 框架时，大多数情况下，在幕后它仍然使用 cURL 或 php 流。大多数 cURL 可以在您的网络托管提供商处获得。否则检查 phpinfo(); 您可以继续操作，因为使用 Joomla 框架的示例将模拟使用 cURL 的示例。

定义一些变量

首先，我们定义一些在所有 cURL 请求中使用的变量

您的 Joomla 4.x 网站的 URL 和
超级用户帐户的 Joomla API 令牌，或至少具有 core.login.api 权限和 core.login.site 权限的帐户，以便能够查看更改当前登录用户的令牌。

// Before passing the HTTP METHOD to CURL
use Joomla\Http\HttpFactory;
use Joomla\Uri\Uri;

$http = (new HttpFactory())->getAvailableDriver();
$url   = 'https://example.org/api/index.php/v1';
$uri  = new Uri($url);

// Put your Joomla! Api token in a safe place, for example a password manager or a vault storing secrets
// We should not use environment variables to store secrets.
// Here is why: https://www.trendmicro.com/en_us/research/22/h/analyzing-hidden-danger-of-environment-variables-for-keeping-secrets.html

$token = '';

POST - 在“未分类”类别中创建文章（类别 ID = 2）

$categoryId = 2; // Joomla's default "Uncategorized" Category

$data = [
'title'       => 'How to add an article to Joomla via the API?',
'alias'       => 'how-to-add-article-via-joomla-api',
'articletext' => 'I have no idea...',
'catid'       => $categoryId,
'language'    => '*',
'metadesc'    => '',
'metakey'     => '',
];

$dataString = json_encode($data);

// HTTP request headers
$headers = [
'Accept: application/vnd.api+json',
'Content-Type: application/json',
'Content-Length: ' . mb_strlen($dataString),
sprintf('X-Joomla-Token: %s', trim($token)),
];

// Timeout in seconds
$timeout = 30;

// Set path for creating an article it will set the current uri path part
$uri->setPath('content/articles');

// Will be a PSR-7 compatible Response
$response = $http->request('POST', $uri, $dataString, $headers, $timeout);

// The response body is now a stream, so you need to do
echo $response->body;

GET - 从“未分类”类别中检索所有文章

$categoryId = 2; // Joomla's default "Uncategorized" Category

// Don't send payload to server
$dataString = null;

// HTTP request headers
$headers = [
'Accept: application/vnd.api+json',
'Content-Type: application/json',
sprintf('X-Joomla-Token: %s', trim($token)),
];

// Timeout in seconds
$timeout = 30;

// Set path for getting all articles it will set the current uri path part
$uri->setPath('content/articles');

// Will be a PSR-7 compatible Response
$response = $http->request('GET', $uri, $dataString, $headers, $timeout);

// The response body is now a stream, so you need to do
echo $response->body;

GET - 检索特定文章

$articleId = 1; // The Article ID of a specific Article

// Don't send payload to server
$dataString = null;

// HTTP request headers
$headers = [
'Accept: application/vnd.api+json',
'Content-Type: application/json',
sprintf('X-Joomla-Token: %s', trim($token)),
];

// Timeout in seconds
$timeout = 30;

// Set path for getting a specific article it will set the current uri path part
$uri->setPath(sprintf('content/articles/%d', $articleId));

// Will be a PSR-7 compatible Response
$response = $http->request('GET', $uri, $dataString, $headers, $timeout);

// The response body is now a stream, so you need to do
echo $response->body;

PATCH - 修改特定文章

$articleId = 1; // The Article ID of a specific Article

$data = [
'id'          => $articleId,
'title'       => 'How to add an article via the Joomla 4 API?',
'introtext'   => 'When using PATCH, articletext MUST be split into two parts or use at least just introtext in order to work properly',
'fulltext'    => 'MORE CONTENT if you wish',
];

$dataString = json_encode($data);

// HTTP request headers
$headers = [
'Accept: application/vnd.api+json',
'Content-Type: application/json',
'Content-Length: ' . mb_strlen($dataString),
sprintf('X-Joomla-Token: %s', trim($token)),
];

// Timeout in seconds
$timeout = 30;

// Set path for partial update of a specific article it will set the current uri path part
$uri->setPath(sprintf('content/articles/%d', $articleId));

// Will be a PSR-7 compatible Response
$response = $http->request('PATCH', $uri, $dataString, $headers, $timeout);

// show response status code
echo $response->code;

DELETE - 删除特定文章

$articleId = 1; // The Article ID of a specific Article

// Don't send payload to server
$dataString = null;

// HTTP request headers
$headers = [
'Accept: application/vnd.api+json',
'Content-Type: application/json',
sprintf('X-Joomla-Token: %s', trim($token)),
];

// Timeout in seconds
$timeout = 30;

// Set path for deleting of a specific article it will set the current uri path part
$uri->setPath(sprintf('content/articles/%d', $articleId));

// Will be a PSR-7 compatible Response
$response = $http->request('DELETE', $uri, $dataString, $headers, $timeout);

// show response status code
echo $response->code;

使用 PHP cURL 函数

cURL 函数需要在您的 PHP 配置中可用并启用，请检查 phpinfo();

定义一些变量

首先，我们定义一些在所有 cURL 请求中使用的变量

您的 Joomla 4.x 网站的 URL 和
超级用户帐户的 Joomla API 令牌，或至少具有 core.login.api 权限和 core.login.site 权限的帐户，以便能够查看更改当前登录用户的令牌。

// Before passing the HTTP METHOD to CURL
$curl  = curl_init();

$url   = 'https://example.org/api/index.php/v1';

// Put your Joomla! Api token in a safe place, for example a password manager or a vault storing secrets
// We should not use environment variables to store secrets.
// Here is why: https://www.trendmicro.com/en_us/research/22/h/analyzing-hidden-danger-of-environment-variables-for-keeping-secrets.html
$token = '';

POST - 在“未分类”类别中创建文章（类别 ID = 2）

$categoryId = 2; // Joomla's default "Uncategorized" Category


$data = [
'title'       => 'How to add an article to Joomla via the API?',
'alias'       => 'how-to-add-article-via-joomla-api',
'articletext' => 'I have no idea...',
'catid'       => $categoryId,
'language'    => '*',
'metadesc'    => '',
'metakey'     => '',
];

$dataString = json_encode($data);

// HTTP request headers
$headers = [
'Accept: application/vnd.api+json',
'Content-Type: application/json',
'Content-Length: ' . mb_strlen($dataString),
sprintf('X-Joomla-Token: %s', trim($token)),
];

curl_setopt_array($curl, [
		CURLOPT_URL            => sprintf('%s/%s',$url,'content/articles'),
		CURLOPT_RETURNTRANSFER => true,
		CURLOPT_ENCODING       => 'utf-8',
		CURLOPT_MAXREDIRS      => 10,
		CURLOPT_TIMEOUT        => 30,
		CURLOPT_FOLLOWLOCATION => true,
		CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_2TLS,
		CURLOPT_CUSTOMREQUEST  => 'POST',
		CURLOPT_POSTFIELDS     => $dataString,
		CURLOPT_HTTPHEADER     => $headers,
	]
);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

GET - 从“未分类”类别中检索所有文章

$categoryId = 2; // Joomla's default "Uncategorized" Category


// HTTP request headers
$headers = [
'Accept: application/vnd.api+json',
'Content-Type: application/json',
sprintf('X-Joomla-Token: %s', trim($token)),
];

curl_setopt_array($curl, [
		CURLOPT_URL            => sprintf('%s/content/articles?filter[category]=%d',$url,$categoryId),
		CURLOPT_RETURNTRANSFER => true,
		CURLOPT_ENCODING       => 'utf-8',
		CURLOPT_MAXREDIRS      => 10,
		CURLOPT_TIMEOUT        => 30,
		CURLOPT_FOLLOWLOCATION => true,
		CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_2TLS,
		CURLOPT_CUSTOMREQUEST  => 'GET',
		CURLOPT_HTTPHEADER     => $headers,
	]
);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

GET - 检索特定文章

$articleId = 1; // The Article ID of a specific Article


// HTTP request headers
$headers = [
'Accept: application/vnd.api+json',
'Content-Type: application/json',
sprintf('X-Joomla-Token: %s', trim($token)),
];
curl_setopt_array($curl, [
		CURLOPT_URL            => sprintf('%s/content/articles/%d',$url,$articleId),
		CURLOPT_RETURNTRANSFER => true,
		CURLOPT_ENCODING       => 'utf-8',
		CURLOPT_MAXREDIRS      => 10,
		CURLOPT_TIMEOUT        => 30,
		CURLOPT_FOLLOWLOCATION => true,
		CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_2TLS,
		CURLOPT_CUSTOMREQUEST  => 'GET',
		CURLOPT_HTTPHEADER     => $headers,
	]
);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

PATCH - 修改特定文章

$articleId = 1; // The Article ID of a specific Article


$data = [
'id'          => $articleId,
'title'       => 'How to add an article via the Joomla 4 API?',
'introtext'   => 'When using PATCH, articletext MUST be split into two parts or use at least just introtext in order to work properly',
'fulltext'    => 'MORE CONTENT if you wish',
];

$dataString = json_encode($data);

// HTTP request headers
$headers = [
'Accept: application/vnd.api+json',
'Content-Type: application/json',
'Content-Length: ' . mb_strlen($dataString),
sprintf('X-Joomla-Token: %s', trim($token)),
];

curl_setopt_array($curl, [
		CURLOPT_URL            => sprintf('%s/content/articles/%d',$url,$articleId),
		CURLOPT_RETURNTRANSFER => true,
		CURLOPT_ENCODING       => 'utf-8',
		CURLOPT_MAXREDIRS      => 10,
		CURLOPT_TIMEOUT        => 30,
		CURLOPT_FOLLOWLOCATION => true,
		CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_2TLS,
		CURLOPT_CUSTOMREQUEST  => 'PATCH',
		CURLOPT_POSTFIELDS     => $dataString,
		CURLOPT_HTTPHEADER     => $headers,
	]
);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

DELETE - 删除特定文章

$articleId = 1; // The Article ID of a specific Article


// HTTP request headers
$headers = [
'Accept: application/vnd.api+json',
'Content-Type: application/json',
sprintf('X-Joomla-Token: %s', trim($token)),
];

curl_setopt_array($curl, [
		CURLOPT_URL            => sprintf('%s/content/articles/%d',$url,$articleId),
		CURLOPT_RETURNTRANSFER => true,
		CURLOPT_ENCODING       => 'utf-8',
		CURLOPT_MAXREDIRS      => 10,
		CURLOPT_TIMEOUT        => 30,
		CURLOPT_FOLLOWLOCATION => true,
		CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_2TLS,
		CURLOPT_CUSTOMREQUEST  => 'DELETE',
		CURLOPT_HTTPHEADER     => $headers,
	]
);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

与 Joomla 4.x Web 服务 API 通信

使用 Joomla 框架​

定义一些变量​

POST - 在“未分类”类别中创建文章（类别 ID = 2）​

GET - 从“未分类”类别中检索所有文章​

GET - 检索特定文章​

PATCH - 修改特定文章​

DELETE - 删除特定文章​

使用 PHP cURL 函数​

定义一些变量​

POST - 在“未分类”类别中创建文章（类别 ID = 2）​

GET - 从“未分类”类别中检索所有文章​

GET - 检索特定文章​

PATCH - 修改特定文章​

DELETE - 删除特定文章​

使用 Joomla 框架

定义一些变量

POST - 在“未分类”类别中创建文章（类别 ID = 2）

GET - 从“未分类”类别中检索所有文章

GET - 检索特定文章

PATCH - 修改特定文章

DELETE - 删除特定文章

使用 PHP cURL 函数

定义一些变量

POST - 在“未分类”类别中创建文章（类别 ID = 2）

GET - 从“未分类”类别中检索所有文章

GET - 检索特定文章

PATCH - 修改特定文章

DELETE - 删除特定文章