README

具有API访问权限的账户可以使用RESTful Provisioning API创建和管理他们的产品环境、用户和用户组。

Provisioning API访问权限可供申请的企业计划账户使用。

有关更多信息，请访问https://support.cloudinary.com。

安装和用法

要求

PHP 8.1及更高版本。

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "git@github.com:cloudinary/account-provisioning-php.git"
    }
  ],
  "require": {
    "cloudinary/account-provisioning": "*"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

<?php
require_once('/path/to/account-provisioning/vendor/autoload.php');

配置

API使用HTTPS上的基本身份验证。

您的Cloudinary 账户ID、Provisioning Key和Provisioning Secret用于身份验证。

这些ID位于Cloudinary控制台下的设置 > 账户 > Provisioning API访问，或者可以从Cloudinary控制台上的配置环境变量中获取，该变量可在控制台仪表板上找到

（格式：CLOUDINARY_ACCOUNT_URL=account://<PROVISIONING_KEY>:<PROVISIONING_SECRET>@<ACCOUNT_ID>）。

您可以选择在每个$apiInstance初始化时传递配置

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

// Configure Cloudinary Account URL
$config = Cloudinary\Provisioning\Configuration::getDefaultConfiguration()
              ->setCloudinaryAccountUrl('account://provisioning_key:provisioning_secret@account_id');

$apiInstance = new Cloudinary\Provisioning\Api\ProductEnvironmentsApi(null, $config);

或全局设置环境变量。

例如，要设置临时环境变量

在Mac或Linux上

export CLOUDINARY_ACCOUNT_URL=account://provisioning_key:provisioning_secret@account_id

在Windows上

set CLOUDINARY_ACCOUNT_URL=account://provisioning_key:provisioning_secret@account_id

然后您可以按如下方式初始化$apiInstance

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

$apiInstance = new Cloudinary\Provisioning\Api\ProductEnvironmentsApi();

入门

请遵循安装程序，然后运行以下命令

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

$apiInstance = new Cloudinary\Provisioning\Api\ProductEnvironmentsApi();

$enabled = true; // bool | Whether to only return enabled product environments (true) or disabled product environments (false).  **Default**: all product environments are returned (both enabled and disabled).
$ids = array('ids_example'); // string[] | A list of up to 100 product environment IDs. When provided, other parameters are ignored.
$prefix = "product"; // string | Returns product environments where the name begins with the specified case-insensitive string.

try {
    $result = $apiInstance->getProductEnvironments($enabled, $ids, $prefix);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProductEnvironmentsApi->getProductEnvironments: ', $e->getMessage(), PHP_EOL;
}

API端点

所有URI都是相对于https://api.cloudinary.com/v1_1/provisioning/accounts/ACCOUNT_ID的，除非操作定义了另一个基本路径。

模型

授权

basicAuth

类型：HTTP基本身份验证

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

support@cloudinary.com

关于此包

此Cloudinary Account Provisioning API PHP包是自动生成的。

包版本：0.0.6
API版本：0.0.4
构建包：org.openapitools.codegen.languages.PhpNextgenClientCodegen

cloudinary / account-provisioning

维护者

详细信息