README

API Delivery PHP

Codificar 开发的库。

简介

该 SDK 由 Codificar 构建，旨在使调用交付方法变得灵活，以便所有用户都可以使用所有版本的 API 的所有功能。

您可以通过访问此链接来访问 API 的官方文档。

安装

使用以下命令安装库

composer require codificar/delivery-api-php

配置

要将库添加到您的项目中，只需执行以下操作

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

$delivery = new Delivery\Client();

定义自定义头信息

如果需要，您可以定义自定义 HTTP 头信息来请求。为此，只需在实例化 Client 对象时提供它们即可。

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

$delivery = new Delivery\Client(
    $base_url,
    ['headers' => ['MEU_HEADER_CUSTOMIZADO' => 'VALOR HEADER CUSTOMIZADO']]
);

然后，您可以使用该客户端向 Codificar 的 Delivery 发送请求，如下面的示例所示。

请求行程

本节将解释如何使用该库在 Delivery 中执行行程请求。

创建一个新的近邻提供商请求

<?php
 $options = [
        'institution_id' => <USER_ID:INT>,
        'token' => <TOKEN:STRING>,
        'provider_type' => <PROVIDER_TYPE:INT>,
        'payment_mode' => <PAYMENT_MODE:INT>,
        'return_to_start' => <BOOLEAN>,
        'points' => array(
            array(
                'title' => <POINT_A:STRING>,
                'action_type' => <ACTION_TYPE:INT>,
                'action' => <ACTION:STRING>,
                'collect_value' => <COLLECT_VALUE:FLOAT>,
                'change' => <CHANGE:FLOAT>,
                'form_of_receipt' => <FORM_OF_RECEIPT:INT('Dinheiro'=1, 'Maquina'=4, 'None'=0)>,
                'collect_pictures' => <BOOLEAN>,
                'collect_signature' => <BOOLEAN>,
                'geometry' => array(
                    'location' => array(
                        'lat' => <LATITUDE:FLOAT>,
                        'lng' => <LONGITUTDE:FLOAT>
                    )
                ),
            'address' => <FULL_ADDRESS:STRING>
            ),
            array(
                'title' => <POINT_B:STRING>,
                'action_type' => <ACTION_TYPE:INT>,
                'action' => <ACTION:STRING>,
                'collect_value' => <COLLECT_VALUE:FLOAT>,
                'change' => <CHANGE:FLOAT>,
                'form_of_receipt' => <FORM_OF_RECEIPT:INT('Dinheiro'=1, 'Maquina'=4, 'None'=0)>,
                'collect_pictures' => <BOOLEAN>,
                'collect_signature' => <BOOLEAN>,
                'order_id' => <ORDER_ID>,
                'geometry' => array(
                    'location' => array(
                        'lat' => <LATITUDE:FLOAT>,
                        'lng' => <LONGITUTDE:FLOAT>
                    )
                ),
            'address' => <FULL_ADDRESS:STRING>
            ),
        ),
    ];
$delivery = new Delivery\Client();
$request = $delivery->ride()->create($options);

取消一个请求

<?php
 $options = [
        'institution_id' => <USER_ID:INT>,
        'token' => <TOKEN:STRING>,
        'request_id' => <REQUEST_ID:INT>,
        'reason' => <REASON:STRING>
    ];
$delivery = new Delivery\Client();
$request = $delivery->ride()->cancel($options);

生成行程估算

本节将解释如何使用该库在 Delivery 中执行估算请求。

<?php
$options = [
        'institution_id' => <USER_ID:INT>,
        'token' => <TOKEN:STRING>,
        'provider_type' => <PROVIDER_TYPE:INT>,
        'payment_mode' => <PAYMENT_MODE:INT>,
        'return_to_start' => <BOOLEAN>,
        'points' => array(
            array(
                'title' => <POINT_A:STRING>,
                'action_type' => <ACTION_TYPE:INT>,
                'action' => <ACTION:STRING>,
                'collect_value' => <COLLECT_VALUE:FLOAT>,
                'change' => <CHANGE:FLOAT>,
			          'form_of_receipt' => <FORM_OF_RECEIPT:STRING>('Dinheiro'=1, 'Maquina'=4, 'None'=0)>,
			          'collect_pictures' => <BOOLEAN|DEFAULT: false>,
			          'collect_signature' => <BOOLEAN|DEFAULT: false>,
                'geometry' => array(
                    'location' => array(
                        'lat' => <LATITUDE:FLOAT>,
                        'lng' => <LONGITUTDE:FLOAT>
                    )
                ),
            'address' => <FULL_ADDRESS:STRING>
            ),
            array(
                'title' => <POINT_B:STRING>,
                'action_type' => <ACTION_TYPE:INT>,
                'action' => <ACTION:STRING>,
                'collect_value': <COLLECT_VALUE:INT>,
			          'change': <NULL>,
			          'form_of_receipt': <FORM_OF_RECEIPT:STRING>('Dinheiro'=1, 'Maquina'=4, 'None'=0)>,
			          'collect_pictures': <BOOLEAN|DEFAULT: false>,
			          'collect_signature': <BOOLEAN|DEFAULT: false>,
                'geometry' => array(
                    'location' => array(
                        'lat' => <LATITUDE:FLOAT>,
                        'lng' => <LONGITUTDE:FLOAT>
                    )
                ),
            'address' => <FULL_ADDRESS:STRING>
            ),
        )
    ];

$delivery = new Delivery\Client();
$estimate = $delivery->ride()->estimate($options);

行程详情

本节将解释如何使用该库在 Delivery 中获取行程详情。

<?php
$options = [
        'institution_id' => <USER_ID:INT>,
        'token' => <TOKEN:STRING>,
        'id' => <ID_CORRIDA:INT>,
    ];

$delivery = new Delivery\Client();
$estimate = $delivery->ride()->details($options);

重新发送一个行程

本节将解释如何使用该库在 Delivery 中重新发送一个行程。

<?php

$delivery = new Delivery\Client();
$estimate = $delivery->ride()->resend(['request_id' => <ID>]);

商店请求

本节将解释如何使用该库创建一个新的商店。

创建一个新的商店

个人类型

<?php
 $options = [
        "person" => <TYPE_PERSON:INT('Física'=1, 'Jurídica'=2)>,
        "show_key_if_exists" => <BOOLEAN|DEFAULT: false>,
        "user" => [
            "name" => <NAME:STRING>,
            "document" => <NUMBER_DOCUMENT:STRING>,
            "email" => <EMAIL:STRING>,
            "phone" => <FULL_PHONE:STRING>,
            "password" => <PASSWORD:STRING>,
            "passwordRepeat" => <PASSWORD_REPEAT:STRING>,
            "acknowledgement" => <ACKNOWLEDGEMENT:STRING>,
        ],
        "address" => [
            "street" => <STREET_STORE:STRING>,
            "zip_code" => <ZIP_CODE:STRING>,
            "state" => <STATE:STRING>,
            "district" => <DISTRICT:STRING>,
            "city" => <CITY:STRING>,
            "country" => <COUNTRY:STRING>,
            "complement" => <COMPLEMENT:STRING>,
            "number" => <NUMBER:STRING>
        ]
    ];
?>

企业类型

<?php
 $options = [
        "person" => <TYPE_PERSON:INT('Física'=1, 'Jurídica'=2)>,
        "show_key_if_exists" => <BOOLEAN|DEFAULT: false>,
        "institution" => [
            "name" => <NAME:STRING>,
            "social_reason" => <SOCIAL_REASON:STRING>,
            "document" => <NUMBER_DOCUMENT:STRING>,
            "responsible" => <RESPONSIBLE:STRING>,
            "responsible_position" => <RESPONSIBLE_POSITION:STRING>,
            "email" => <EMAIL:STRING>,
            "phone" => <FULL_PHONE:STRING>,
            "acknowledgement" => <ACKNOWLEDGEMENT:STRING>,
        ],
        "admin" => [
            "username" => <USERNAME:STRING>,
            "password" => <PASSWORD:STRING>,
            "passwordRepeat" => <PASSWORD_REPEAT:STRING>,

        ],
        "address" => [
            "street" => <STREET_STORE:STRING>,
            "zip_code" => <ZIP_CODE:STRING>,
            "state" => <STATE:STRING>,
            "district" => <DISTRICT:STRING>,
            "city" => <CITY:STRING>,
            "country" => <COUNTRY:STRING>,
            "complement" => <COMPLEMENT:STRING>,
            "number" => <NUMBER:STRING>
        ]
    ];
?>

现在发送带有 $options 的请求。

<?php
$delivery = new Delivery\Client();
$request = $delivery->store()->create($options);
?>

codificar / delivery-api-php

维护者

详细信息