README

此项目不再受支持，请考虑使用 https://api.swikly.com 或 https://apisandbox.swikly.com 来使用沙箱环境。

新的 SWIKLY_LINK。

这是一个独特的网络链接，与您的 Swikly 账户配合使用。它允许您请求预存款或已知的固定金额的存款。

SWIKLY_LINK 文档

您可以通过 Swikly 账户注册这里。

Swikly PHP SDK

Swikly 提供了一种简单易行的新方法来请求相当于预付款或保证金（我们称之为“swik”），但无需转账。

当您请求 swik 时，您实际上是在要求您的客户提供一个信用卡预留，指定金额和预留存款的期限。

这允许您远程轻松、完全有信心地保障您的预订或请求预付款或保证金。Swikly 还提供了一种比大多数竞争对手更便宜的支付选项。

要求

PHP 5.6.0 及以上。

Composer

您可以通过 Composer 安装 Swikly SDK

composer require swikly/swikly-php

要使用 SDK，请使用 Composer 的 autoload

require_once('vendor/autoload.php');

手动安装

如果您不想使用 Composer，您可以下载源代码。然后，要使用 SDK，请包含 init.php 文件。

require_once('/path/to/swikly-php/init.php');

资源

Wiki：了解所有 SDK 功能及其使用方法。

Github 仓库：示例位于 examples 目录中。

API 文档：关于此 SDK 使用的 API 的最新文档。

快速示例

创建 Swikly API 客户端

<?php
// Require the Composer autoloader.
require 'vendor/autoload.php';

use Swikly\Swik;
use Swikly\SwiklyAPI;

//Instantiate a Swikly API client
$swkAPI = new SwiklyAPI('Your_Api_Key', 'YOUR_API_SECRET', 'development');

创建新的 Swik

<?php
// Create a swik object
$swik = new Swik();

// Set all the swik informations
$swik->setClientFirstName("Jean")
    ->setClientLastName("Dupont")
    ->setClientEmail("jean.dupont@gmail.com")
    ->setClientPhoneNumber("+33 6 20 20 20 20") // Send SMS to that number
    ->setClientLanguage("FR") // "EN" or "FR"
    ->setSwikAmount("50")
    ->setSwikDescription("1h de canyoning le 12/08/2017....")
    ->setSwikEndDay("12")
    ->setSwikEndMonth("08")
    ->setSwikEndYear("2017")
    ->setSwikId("YOUR_ID")
    ->setSendEmail("true")
    ->setSwikType("security deposit") // "reservation" or "security deposit"
    ->setCallbackUrl('https://mywebsite.com/resultSwik');

// Create and send your new swik to your client
$result = $swkAPI->newSwik($swik);

// Print result of the operation
if ($result['status'] == 'ok') {
	echo "New swik created\n";
    echo "Your client can accept the swik at this address: " . $result['acceptUrl'];
} else {
	echo "Failed to create the swik";
	echo "Error = " . $result['message'];
}

创建新的付款

<?php
// Create a swik object
$swik = new \Swikly\Swik();

// Set all the swik informations
$swik->setClientFirstName("Jean")
    ->setClientLastName("Dupont")
    ->setClientEmail("jean.dupont@gmail.com")
    ->setClientPhoneNumber("+33 6 20 20 20 20") // Send SMS to that number
    ->setClientLanguage("FR") // "EN", "FR", 'NL', 'DE'
    ->setSwikAmount("50")
    ->setSwikDescription("1h de canyoning le 12/08/2017....")
    ->setSwikId("YOUR_ID")
    ->setSendEmail("true")
    ->setCallbackUrl('https://mywebsite.com/resultSwik');

// Create and send your new swik to your client
$result = $swkAPI->newPayment($swik);

// Print result of the operation
if ($result['status'] == 'ok') {
    echo "New payment created\n";
    echo "Your client can pay you at this address: " . $result['acceptUrl'];
} else {
    echo "Failed to create a newPayment";
    echo "Error = " . $result['message'];
}

取消 swik

<?php

// Create a swik object
$swik = new Swik();

// Set the Swik Id (yours or the one from Swikly)
$swik->setSwikId("YOUR_ID");

// Deleting the swik
$result = $swkAPI->deleteSwik($swik);

// Print result of the operation
if ($result['status'] == 'ok') {
    echo "Swik deleted correctly";
} else {
    echo "Failed to delete the swik";
    echo "Error = " . $result['message'];
}

获取特定的 Swik

<?php

// Create a swik object
$swik = new Swik();

// Set the Id you used to create it
$swik->setSwikId("YOUR_ID");

// Get the list of your swiks
$result = $swkAPI->getSwik($swik);

// Print result of the operation
if ($result['status'] == 'ok') {
    echo "My swik = ";
    print_r($result['swik']);
} else {
    echo "Failed to get the swik";
    echo "Error = " . $result['message'];
}

列出我的所有 Swiks

<?php

// Get the list of your swiks
$result = $swkAPI->getListSwik();

// Print result of the operation
if ($result['status'] == 'ok') {
    echo "List of swik(s) = ";
    print_r($result['list']);
} else {
    echo "Failed to get the swik list";
    echo "Error = " . $result['message'];
}

swikly / swikly-php

维护者

详细信息