codificar / delivery-api-php
Delivery Codificar PHP Library
Installs: 4 240
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Type:lib
Requires
- php: >=5.6.0
- guzzlehttp/guzzle: ^6.4
Requires (Dev)
- phpunit/phpunit: ^8
- squizlabs/php_codesniffer: ^3.3
This package is auto-updated.
Last update: 2024-10-29 05:53:05 UTC
README
API Delivery PHP
Biblioteca desenvolvida pela Codificar .
Introdução
Essa SDK foi construída pela Codificar com o intuito de tornar flexível as chamadas dos metodos de entrega, de forma que todos possam utilizar todas as features, de todas as versões de API.
Você pode acessar a documentação oficial da API acessando esse link.
Índice
Instalação
Instale a biblioteca utilizando o comando
composer require codificar/delivery-api-php
Configuração
Para incluir a biblioteca em seu projeto, basta fazer o seguinte:
<?php require('vendor/autoload.php'); $delivery = new Delivery\Client();
Definindo headers customizados
- Se necessário for é possível definir headers http customizados para os requests. Para isso basta informá-los durante a instanciação do objeto
Client
:
<?php require('vendor/autoload.php'); $delivery = new Delivery\Client( $base_url, ['headers' => ['MEU_HEADER_CUSTOMIZADO' => 'VALOR HEADER CUSTOMIZADO']] );
E então, você pode poderá utilizar o cliente para fazer requisições ao Delivery da codificar, como nos exemplos abaixo.
Requisição de corrida
Nesta seção será explicado como realizar requisições de corridas no Delivery com essa biblioteca.
Criando uma nova requisicao para um provider próximo
<?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);
Cancelando uma requisicao
<?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);
Gerar estimativa da corrida
Nesta seção será explicado como realizar requisições para estimativas no Delivery com essa biblioteca.
<?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);
Detalhes da corrida
Nesta seção será explicado como realizar requisições para obter os detalhes da corrida no Delivery com essa biblioteca.
<?php $options = [ 'institution_id' => <USER_ID:INT>, 'token' => <TOKEN:STRING>, 'id' => <ID_CORRIDA:INT>, ]; $delivery = new Delivery\Client(); $estimate = $delivery->ride()->details($options);
Reenviar uma corrida
Nesta seção será explicado como realizar requisições para reenviar uma corrida no Delivery com essa biblioteca.
<?php $delivery = new Delivery\Client(); $estimate = $delivery->ride()->resend(['request_id' => <ID>]);
Requisição de store
Nesta seção será explicado como realizar requisições para criar uma nova store com essa biblioteca.
Criando uma nova store
Do tipo Pessoa Física
<?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> ] ]; ?>
Do tipo Pessoa Jurídica
<?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> ] ]; ?>
Agora envie a solicitação com a $options
desejada.
<?php $delivery = new Delivery\Client(); $request = $delivery->store()->create($options); ?>