README

VisaLogic API类

1. 简介

本文档包含了VisaLogic应用程序编程接口的文档。这是一个将使用技术语言并需要技术知识来实现的文档。

2. 安装

2.1 通过Composer

我们的API类通过composer提供。

您可以使用以下命令安装我们的依赖

composer require visalogic/api

在您的项目中，您应该require composer的autoload.php文件

<?php
    require 'vendor/autoload.php';

2.2 通过Github

我们的API类也可在Github上找到。

当您选择从Github安装时，您需要将src/目录下的所有文件添加到您的项目中。

3. 配置

我们所有的API类都是以VisaLogic为命名空间。

3.1 获取API密钥

您可以通过我们的后台办公室获取API密钥。

3.2 设置API密钥

您可以通过通过构造函数传递它来设置API密钥

$visalogic = new VisaLogic\Api('your-api-key');

4. 可用方法

4.1 获取您的订单

您可以通过调用getOrders();方法请求您的订单。这将获取您最后15个订单。

$visalogic->getOrders();

订单是分页的。要请求下一个15个订单，您可以提供一个页码作为第一个参数。

$visalogic->getOrders($page = 2);

4.2 获取一个订单

要请求一个订单及其详细信息，您可以调用getOrder();方法。参数是它的id。

$visalogic->getOrder($id = 1);

4.3 创建订单

要创建订单，您可以调用createOrder();方法。这将返回一个新的VisaLogic\Resources\Order实例。

通过将订单详细信息作为数组传递给参数，将为您设置Order实例上的属性。

$order = $visalogic->createOrder([
    'email'                   => 'johndoe@example.com',
    'phone_number'            => '31' . '12345678',
    'addressee'               => 'John Doe',
    'addressline'             => 'Examplestreet 1',
    'addressline_1'           => '1234 AB City',
    'country'                 => 'NL',
    'customer_purchase_price' => 25,
    'order_created'           => 'YYYY-MM-DD HH:MM:SS'
    'remote_name'             => 'Order 1' // optional
]);

然后您可以通过在Order对象上调用addApplication();方法将应用程序添加到订单中

$order->addApplication([
    'firstnames'           => 'John',
    'lastnames'            => 'Doe',
    'date_of_birth'        => '1990-01-01',
    'place_of_birth'       => 'City',
    'nationality'          => 'NL',
    'document_type'        => 'passport',
    'document_number'      => 'AA1BBBB22',
    'document_issue_date'  => '2010-01-01',
    'document_expire_date' => '2020-01-02',
    'visa_start_date'      => 'YYYY-MM-DD' // This date has to be after yesterday
]);

国籍可以是NL或BE，而document_type可以是passport或id_card。对于一个订单，所有的document_type值和visa_start_date值都必须相同。如果情况不是这样，请创建两个单独的订单。

4.3 提交订单

当您完成订单创建后，可以使用接受Order对象作为第一个参数的postOrder();方法将其发送给我们。

$visalogic->postOrder($order);

4.4 获取签证申请状态

您可以通过调用以下方法请求签证申请的状态，传递application_id。

$application_status = $visalogic->getStatus($application_id = 1);

此方法将返回以下字符串之一

APPROVED 申请已批准
PENDING 申请正在等待处理
BUSY 申请正在由签证供应商处理
RECEIVING 等待接收签证文件
REJECTED 申请已被拒绝

4.3 获取签证文件

4.3.1 下载PDF

如果申请的状态是APPROVED，您可以调用getVisa();请求签证文件。

$visalogic->getVisa($application_id = 1);

此方法将为要下载的PDF文件设置头部，并返回签证文件。

visalogic / api

维护者

详细信息