kukulkan-popolvux/coinspaid-api-laravel

该包为与 https://coinspaid.com 服务的 API(v2)交互提供了便捷的接口

1.0.2 2021-07-17 12:47 UTC

This package is auto-updated.

Last update: 2024-09-17 20:58:24 UTC


README

该包为与 CoinsPaid 服务的 API(v2)交互提供了便捷的接口

安装

composer

使用包管理器 composer 安装 coinspaid-api-laravel

composer require kukulkan-popolvux/coinspaid-api-laravel

provider

将 ServiceProvider 添加到 config/app.php 中的 providers 数组

KukulkanPopolvux\CoinspaidApiLaravel\CoinspaidApiLaravelProvider::class,

.env

要配置与 CoinsPaid 服务的连接并指定开发环境,您必须在 .env 文件中使用以下常量

COINSPAID_API_KEY=
COINSPAID_SECRET_KEY=
COINSPAID_ENVIRONMENT=

获取 API 密钥和密钥

要获取 COINSPAID_API_KEYCOINSPAID_SECRET_KEY,您必须执行以下步骤,这些步骤在 文档 中有描述

开发环境

默认情况下,开发环境被列为生产环境。您可以选择两个值 testprod
示例: COINSPAID_ENVIRONMENT=test

常量 COINSPAID_DOMAIN_PRODCOINSPAID_DOMAIN_TEST

如果您希望覆盖 conispide 服务的 API 域名,可以使用这些常量,但请勿这样做。
除非服务器本身的 API 域名更改,并且这个库没有时间做出更改。
示例: COINSPAID_DOMAIN_PROD=https://app.cryptoprocessing.com/api/v2
示例: COINSPAID_DOMAIN_TEST=https://app.sandbox.cryptoprocessing.com/api/v2
文档

配置

如果您需要配置文件,可以使用以下命令。
该文件将出现在 config 目录中,名称为 coinspaid.php。
config/coinspaid.php

php artisan vendor:publish --provider="KukulkanPopolvux\CoinspaidApiLaravel\CoinspaidApiLaravelProvider"

使用

配置后,您可以直接使用库,无需指定任何其他值。

示例

\KukulkanPopolvux\CoinspaidApiLaravel\Coinspaid::ping()->getBody();

\KukulkanPopolvux\CoinspaidApiLaravel\Coinspaid::run()->getBody();

返回 Response 对象。调用 getBody() 方法将返回响应体
答案应返回 OK,它无需密钥和 API 密钥即可工作。
这只是一个库连接及其与 CoinsPaid 服务的交互的测试。
文档

示例

\KukulkanPopolvux\CoinspaidApiLaravel\Coinspaid::getListCurrencies()->getBodyObject();

\KukulkanPopolvux\CoinspaidApiLaravel\Coinspaid::getListCurrencies()->getBody(true);

getBodyObject() 将返回转换为对象的响应体,或者您可以使用带有参数 truegetBody(true) 方法
此示例显示了需要密钥和 API 密钥的值的方法。
获取所有支持货币的列表。
文档

示例

\KukulkanPopolvux\CoinspaidApiLaravel\Coinspaid::getListCurrencies()->getData();

从请求响应中返回 data 值。
您可以将参数传递给方法 getData('currency'),该方法将返回您传递的参数的值

许可

MIT