README

The Push API allows you to push items and security identities, as opposed to letting standard Coveo Cloud V2 crawlers pull this data from a content repository. This is especially useful when you need to index content from a cloud or on-premises system for which no dedicated source type exists in the Coveo Cloud V2 platform.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

composer require neclimdul/coveo-push-api

Getting Started

Please follow the installation procedure and then run the following:

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

use NecLimDul\Coveo\PushApi\ApiException;

// Configure OAuth2 access token for authorization: oauth2
$config = \NecLimDul\Coveo\PushApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new \NecLimDul\Coveo\PushApi\Api\FileContainerApi(
    // 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 Coveo Cloud V2 organization.   **Example:** `mycoveocloudv2organizationg8tp8wu3`
$use_virtual_hosted_style_url = True; // bool | Whether to generate the presigned URL using the virtual hosted-style URL.   **Example of a virtual hosted-style url:** `https://coveo-nprod-customerdata.s3.us-east-1.amazonaws.com/proda/blobstore/mycoveocloudv2organizationg8tp8wu3/b5e8767e-8f0d-4a89-9095-1127915c89c7[...]`

try {
    $result = $apiInstance->organizationsOrganizationIdFilesPost($organization_id, $use_virtual_hosted_style_url);
    print_r($result);
} catch (ApiException $e) {
    echo 'Exception when calling FileContainerApi->organizationsOrganizationIdFilesPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.cloud.coveo.com/push/v1

Models

• BaseIdentityBody
• CatalogStreamOutArgs
• ChunkOutArgs
• DocumentBody
• EntityUpdateResult
• Error
• GatewayTimeoutError
• Identity
• IdentityBody
• InlineUpdateBody
• MappedIdentity
• MappedIdentityBody
• OpenStreamOutArgs
• PermissionIdentityModel
• PermissionSetsModel
• PresignedUploadUrl

Authorization

oauth2

• Type: OAuth
• Flow: implicit
• Authorization URL: https://platform.cloud.coveo.com/oauth/authorize
• Scopes:
  • full: Required

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 2016-03-03T13:22:11Z
• Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen