mediapost/api-client-php

MediaPost API 客户端

v1.2.1 2018-04-05 15:32 UTC

This package is not auto-updated.

Last update: 2024-09-15 21:58:09 UTC


README

安装

通过composer

修改您的require部分中的composer.json,并使用composer update mediapost/api-client-php下载依赖。

{
  "require": {
    "mediapost/api-client-php": "^1.1.0"
  }
}

或者直接添加依赖:composer require mediapost/api-client-php:^1.1.0

手册

  1. 下载此客户端的最新版本,并将其解压缩到您的应用程序目录中。
  2. 创建一个autoloading系统或使用现成的系统。
  3. 正常初始化客户端。

代码

初始化

<?php
// Autoloading do composer ou outro à sua escolha
require 'vendor/autoload.php';

// Instanciando o client
$mapi = new Mapi\Client(
    '' /* $ConsumerKey */,
    '' /* $ConsumerSecret */,
    '' /* $Token */,
    '' /* $TokenSecret */
);

请求

<?php
// Inicialização do cliente ...

try {
    // Requisições GET
    $response = $mapi->get('url/do/recurso');

    // Requisições DELETE
    $response = $mapi->delete('url/do/recurso');

    // Requisições POST
    $response = $mapi->post('url/do/recurso', [
        'campo' => 'valor',
        'campo2' => 'valor2'
    ]);

    // Requisições PUT
    $response = $mapi->put('url/do/recurso', [
        'campo' => 'valor',
        'campo2' => 'valor2'
    ]);
} catch (Mapi\Exception $e) {
    // Erro de requisição
    var_dump($e);
} catch (Exception $e) {
    // Erro genérico (por exemplo, parâmetros inválidos)
    var_dump($e);
}

响应

所有请求都返回一个类型为Mapi\Response的对象。

<?php
// Inicialização do cliente ...

// Retorna a quantidade de registros que o recurso pode retornar (desconsiderando a paginação)
var_dump($response->getTotalCount());

// Essa classe se comporta como um array...

// ... podendo ser iterada...
foreach ($response as $key => $value) {
    var_dump($key, $value);
}

// ... e também acessada
var_dump(count($response));
var_dump($response['key']);

// Se preferir lidar realmente com um array, basta invocar o método toArray()
$arr = $response->toArray();

凭证

要访问API,您需要四个访问凭证:消费者密钥、消费者密钥、令牌和令牌密钥

要请求这些数据,您必须联系支持团队,通过您的@MediaPost账户创建一个工单。

测试

测试文件夹中有一些示例文件,演示了如何使用资源。

在访问这些测试之前,您需要修改同一文件夹中conf.php文件中找到的凭证。

完整文档可在https://www.mediapost.com.br/api/找到。