README

Coveo 平台的 API

更多信息，请访问 https://connect.coveo.com/s/discussions。

安装与使用

要求

PHP 8.1 及更高版本。

Composer

要使用 Composer 安装绑定，请将以下内容添加到 composer.json

composer require neclimdul/coveo-field-api

入门指南

请按照 安装过程 操作，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use NecLimDul\Coveo\FieldApi\ApiException;

// Configure OAuth2 access token for authorization: oauth2
$config = \NecLimDul\Coveo\FieldApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new \NecLimDul\Coveo\FieldApi\Api\FieldsApi(
    // If you want to use custom http client, pass your client which implements `\GuzzleHttp\ClientInterface`.
    // This is optional, `\GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organization_id = 'organization_id_example'; // string | The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
$field_model = new \NecLimDul\Coveo\FieldApi\Model\FieldModel(); // \NecLimDul\Coveo\FieldApi\Model\FieldModel

try {
    $apiInstance->createField($organization_id, $field_model);
} catch (ApiException $e) {
    echo 'Exception when calling FieldsApi->createField: ', $e->getMessage(), PHP_EOL;
}

API 端点

所有 URI 都相对于 https://platform.cloud.coveo.com

模型

• BatchOperationProgressModelFieldModel
• BatchOperationResourceStatusModelFieldModel
• FieldListingFilters
• FieldListingOptions
• FieldModel
• PageModelFieldModel

授权

oauth2

• 类型: OAuth
• 流程: implicit
• 授权 URL: https://platform.cloud.coveo.com/oauth/authorize
• 作用域:
  • full: required

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

关于此包

此 PHP 包是由 OpenAPI Generator 项目自动生成的

• API 版本: 1.0.0
• 构建包: org.openapitools.codegen.languages.PhpClientCodegen