digicol/dcx-sdk-php

数字收藏DC-X数字资产管理系统的官方PHP SDK

2.0.2 2022-02-23 13:52 UTC

This package is not auto-updated.

Last update: 2024-09-24 01:37:02 UTC


README

《DcxApiClient》类帮助您的自定义PHP代码通过基于HTTP的DC-X系统连接到DC-X JSON API(在我们的合作伙伴和客户Wiki中记录)。

版本

如果您需要使用旧的DCX_Api_Client类,请查看1.0.0版本

对于其他人,我们推荐基于最新Guzzle的版本。

基于Composer的项目安装

如果您的PHP项目使用Composer,则安装很简单。

  1. 运行composer require digicol/dcx-sdk-php
  2. 或者在您的项目composer.json文件中添加以下内容
    "require":
    {
        "digicol/dcx-sdk-php": "^2.0"
    },

…然后在您的项目中运行composer update以下载SDK。

非Composer项目的安装

您不必在项目中使用Composer来使用SDK。但是,您仍然需要它(请参阅其安装说明)以在检出源代码后下载SDK的依赖项。

$ git clone https://github.com/digicol/dcx-sdk-php.git
$ cd dcx-sdk-php
$ composer install

在您的PHP代码中,像这样包含SDK的自动加载器

require('/path/to/dcx-sdk-php/vendor/autoload.php');

入门指南

以下是一个检索DC-X收藏夹详细信息的示例(名称、检索文档的链接)

<?php
 
require __DIR__ . '/vendor/autoload.php';
 
$dcxApiClient = new \Digicol\DcxSdk\DcxApiClient
(
    'http://example.com/dcx/api/',
    ['username' => 'testuser', 'password' => 'secret'],
    ['http_useragent' => 'MyCustomProject']
);
 
$httpStatusCode = $dcxApiClient->get
(
    'document',
    [
        'q' => ['channel' => ['ch050dcxsystempoolnative']],
        's' => ['fields' => ['_display_title', 'DateCreated']]
    ],
    $documentsData
);
 
echo "Got search results:\n";
var_dump($httpStatusCode);
print_r($documentsData);
 

有关更多示例,请参阅DC-X JSON API文档