robert430404/mrp-php-sdk

这是一个针对 My Race Pass API 的 PHP SDK

1.0.0 2016-09-10 21:01 UTC

This package is not auto-updated.

Last update: 2024-09-14 19:47:45 UTC


README

Latest Stable Version Build Status License codecov Code Climate

本软件包为您提供了与 My Race Pass API V2 交互的流畅接口。所有端点均受支持,所有请求参数都已完全实现。我们从 API 返回 PHP 对象,以便在您的应用程序中使用。

我们兼容 composer,并在 Packagist 上。我们欢迎在 Github 上提出拉取请求和问题,并期待尽可能多的帮助。

要使用 Composer 安装我们的软件包,请使用以下命令。

composer require robert430404/mrp-php-sdk

或者将此行添加到您的 composer.json 中

"require": {
    "robert430404/mrp-php-sdk": "1.0.0"
}

关于 MRP API V2 的信息

我们完全兼容 MRP API。SDK 将遵循 API 文档中针对每个端点描述的相同要求。

一些基本文档

更深入的文档可以在 这里 找到 ** 目前正在开发中 **

SDK 的 API 文档可以在 这里 找到 ** 完全展示了 SDK 的所有组成部分,从 traits 到 interfaces **

在独立应用程序中使用此软件包非常简单。实例化对象的实例,并通过构造函数传入您的 API 密钥。然后,只需从对象中调用方法来创建您的调用并获取返回的数据。

<?php
     
use mrpsdk\endpoints\points\PointsEndpoint;
     
class YourClass
{
    /**
     * @var PointsEndpoint
     */
    protected $pointsEndpoint;
    
    /**
     * YourClass constructor.
     */
    public function __construct()
    {
        $apiKey = 'XXXXXXX-XXXX-XXXXXX-XXXXXXXXXX';
             
        $this->pointsEndpoint = new PointsEndpoint($apiKey);
    }
    
    /**
     * Returns Data From The MRP API In Object Form From JSON
     * 
     * @return mixed
     */
    public function returnData()
    {
        $data = $this->pointsEndpoint      // Your Object
                     ->setScheduleId(1000) // Builds URL
                     ->setClassId(1000)    // Builds URL
                     ->getRequest();       // Sends Request And Returns Data
            
        return $data;
    }
}