Download stuart client php - stuart client php Download

Cliente php stuart

Para uma documentação completa de todos os pontos de extremidade oferecidos pela Stuart API, você pode visitar a documentação da API Stuart.

Changelog

Visite Changelog

Executando a demonstração

 cd demo
docker build -t stuartphpdemo .
export PATH_TO_PROJECT= " /PUT/HERE/YOUR/PATH/TO/PROJECT/stuart-client-php "
docker run -v $PATH_TO_PROJECT /src:/app/vendor/stuartapp/stuart-client-php/src stuartphpdemo

Instalar

Via compositor:

$ composer require stuartapp/stuart-client-php

Uso

Inicialize o cliente
Criar um emprego
1. Minimalista
2. Completo
  1. Com agendamento na coleta
  2. Com o agendamento na entrega
  3. Com empilhamento (multi-grop)
Conseguir um emprego
Cancelar um emprego
Validar um emprego
Cancelar uma entrega
Obtenha um preço
Obtenha um emprego ETA para pegar
Solicitações personalizadas

Importar a biblioteca

Se o Composer não estiver instalado, instale -o:

$ curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer

Adicione a biblioteca ao seu projeto:

$ composer require stuartapp/stuart-client-php

AutolOlinging

Para carregar todas as classes desta biblioteca, basta executar o automóvel no início do código Stuart

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

$ environment =  Stuart  Infrastructure Environment:: SANDBOX ;

Obtenha credenciais

Para Sandbox (ambiente de teste, correios são bots) https://dashboard.sandbox.stuart.com/settings/api

Para produção (mundo real, correios reais) https://dashboard.stuart.com/settings/api

Inicialize o cliente

 $ environment =  Stuart  Infrastructure Environment:: SANDBOX ;
$ api_client_id = ' REPLACE_BY_YOU_CLIENT_ID_HERE ' ; // can be found here: https://admin.sandbox.stuart.com/client/api
$ api_client_secret = ' REPLACE_BY_YOUR_CLIENT_SECRET_HERE ' ; // can be found here: https://admin.sandbox.stuart.com/client/api
$ authenticator = new  Stuart  Infrastructure  Authenticator ( $ environment , $ api_client_id , $ api_client_secret );

$ httpClient = new  Stuart  Infrastructure HttpClient( $ authenticator )

$ client = new  Stuart  Client ( $ httpClient );

Você também pode passar a instância do seu próprio cliente para o construtor StuartHttpClient :

 $ guzzleClient = new  Guzzle  Client ();
$ httpClient = new  Stuart  Infrastructure  HttpClient ( $ authenticator , $ guzzleClient );

Isso pode ser útil se você precisar anexar utensílios médios ao cliente Guzzle.

Cache

É altamente recomendável adicionar um mecanismo de cache para o processo de autenticação. Para fazer isso, basta estender a classe PsrSimpleCacheCacheInterface e implementar sua própria versão.

Há um cache baseado no disco disponível fora da caixa para você usar. Para usá -lo, basta modificar a inicialização da classe de autenticação e passar na implementação do cache no construtor:

 $ diskCache = new  Stuart  Cache  DiskCache ( " stuart_cache.txt " );
$ authenticator = new  Stuart  Infrastructure  Authenticator ( $ environment , $ api_client_id , $ api_client_secret , $ diskCache );

Debugando problemas de cache de token

Você pode inicializar as classes DiskCache, autenticator e httpclient, passando um valor true para o último parâmetro construtor dessas classes.

Criar um emprego

IMPORTANTE : Mesmo que você possa criar um trabalho com um conjunto mínimo de parâmetros, é altamente recomendável que você preencha o máximo de informações possível para garantir que o processo de entrega corra bem.

Minimalista

Tamanho do pacote baseado

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ client -> createJob ( $ job );

Completo

Tamanho do pacote baseado

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' )
    -> setComment ( ' Wait outside for an employee to come. ' )
    -> setContactCompany ( ' KFC Paris Barbès ' )
    -> setContactFirstName ( ' Martin ' )
    -> setContactLastName ( ' Pont ' )
    -> setContactPhone ( ' +33698348756 ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setComment ( ' code: 3492B. 3e étage droite. Sonner à Durand. ' )
    -> setContactCompany ( ' Durand associates. ' )
    -> setContactFirstName ( ' Alex ' )
    -> setContactLastName ( ' Durand ' )
    -> setContactPhone ( ' +33634981209 ' )
    -> setPackageDescription ( ' Pizza box. ' )
    -> setClientReference ( ' 12345678ABCDE ' ); // Must be unique

$ client -> createJob ( $ job );

Com agendamento na coleta

Para obter mais informações sobre o agendamento de empregos, verifique nossa documentação da API.

 $ job = new  Stuart  Job ();

$ pickupAt = new  DateTime ( ' now ' , new DateTimeZone ( ' Europe/Paris ' ));
$ pickupAt -> add ( new  DateInterval ( ' PT2H ' ));

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' )
    -> setPickupAt ( $ pickupAt );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ client -> createJob ( $ job );

Com agendamento na queda

Para obter mais informações sobre o agendamento de empregos, verifique nossa documentação da API.

Observe que esse recurso só pode ser usado com apenas uma queda.

 $ job = new  Stuart  Job ();

$ dropoffAt = new  DateTime ( ' now ' , new DateTimeZone ( ' Europe/Paris ' ));
$ dropoffAt -> add ( new  DateInterval ( ' PT2H ' ));

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setDropoffAt ( $ dropoffAt );

$ client -> createJob ( $ job );

Com a segmentação da frota

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ job -> setFleets ( array ( 1 ));

$ client -> createJob ( $ job );

Com as informações finais da janela do tempo do cliente (usadas apenas para fins de métricas)

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ now = new DateTime ();
$ later = new DateTime ();
$ later = $ later -> modify ( ' +15 minutes ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setEndCustomerTimeWindowStart ( new DateTime ())
    -> setEndCustomerTimeWindowEnd ( $ later );

$ client -> createJob ( $ job );

Com empilhamento (multi-grop)

Tamanho do pacote baseado

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' )
    -> setComment ( ' Wait outside for an employee to come. ' )
    -> setContactCompany ( ' KFC Paris Barbès ' )
    -> setContactFirstName ( ' Martin ' )
    -> setContactLastName ( ' Pont ' )
    -> setContactPhone ( ' +33698348756 ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setComment ( ' code: 3492B. 3e étage droite. Sonner à Durand. ' )
    -> setContactCompany ( ' Durand associates. ' )
    -> setContactFirstName ( ' Alex ' )
    -> setContactLastName ( ' Durand ' )
    -> setContactPhone ( ' +33634981209 ' )
    -> setPackageDescription ( ' Red packet. ' )
    -> setClientReference ( ' 12345678ABCDE ' ); // Must be unique;

$ job -> addDropOff ( ' 12 avenue claude vellefaux, 75010 Paris ' )
    -> setPackageType ( ' small ' )
    -> setComment ( ' code: 92A42. 2e étage gauche ' )
    -> setContactFirstName ( ' Maximilien ' )
    -> setContactLastName ( ' Lebluc ' )
    -> setContactPhone ( ' +33632341209 ' )
    -> setPackageDescription ( ' Blue packet. ' )
    -> setClientReference ( ' ABCDE213124 ' ); // Must be unique

$ client -> createJob ( $ job );

Conseguir um emprego

Depois de criar um trabalho com sucesso, você pode recuperá -lo desta maneira:

 $ jobId = 126532 ;
$ job = $ client -> getJob ( $ jobId );

Ou quando você cria um novo trabalho:

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ jobWithRoute = $ client -> createJob ( $ job );

$ jobWithRoute -> getDeliveries ();

A API Stuart determina a rota ideal em seu nome, é por isso que o método getDeliveries() retornará uma matriz vazia quando o trabalho ainda não tiver sido criado. O método getDeliveries() retornará uma variedade de Delivery assim que o trabalho for criado.

Cancelar um emprego

Depois de criar um trabalho com sucesso, você pode cancelá -lo dessa maneira:

 $ jobId = 126532 ;
$ result = $ client -> cancelJob ( $ jobId );

O resultado manterá o valor booleano true se o trabalho foi cancelado. Se houve um erro, ele conterá um objeto de erro.

Para obter mais detalhes sobre como o cancelamento funciona, consulte nossa seção de documentação dedicada.

Validar um emprego

Antes de criar um trabalho, você pode validá -lo (área de entrega de controle e formato de endereço). Validar um trabalho é opcional e não o impede de criar um trabalho.

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ result = $ client -> validateJob ( $ job );

O resultado manterá o valor booleano true se o trabalho for válido. Se houve um erro, ele conterá um objeto de erro.

Validar um endereço

Incentivamos a validar um endereço para descobrir se podemos pegar / entregar lá. O número de telefone é opcional apenas para os locais em que o endereço é específico o suficiente.

 $ client -> validatePickupAddress ( ' Pau Claris, 08037 Barcelona ' , ' +34677777777 ' );
$ client -> validatePickupAddress ( ' Pau Claris 186, 08037 Barcelona ' );
$ client -> validateDropoffAddress ( ' Pau Claris, 08037 Barcelona ' , ' +34677777777 ' );

Cancelar uma entrega

Depois de criar uma entrega com sucesso, você pode cancelá -lo dessa maneira:

 $ deliveryId = 126532 ;
$ result = $ client -> cancelDelivery ( $ deliveryId );

Obtenha um preço

Antes de criar um emprego, você pode pedir um preço. Pedir um preço é opcional e não o impede de criar um emprego.

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ pricing = $ client -> getPricing ( $ job );

$ pricing -> amount ; // example: 11.5
$ pricing -> currency ; // example: "EUR"

Obtenha um emprego ETA para pegar

Antes de criar um trabalho, você pode solicitar um tempo estimado de chegada ao local da coleta (expresso em segundos). Pedir pelo ETA é opcional e não o impede de criar um emprego.

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ eta = $ client -> getEta ( $ job );

$ eta -> eta ; // example: 672

Solicitações personalizadas

Você também pode enviar solicitações por conta própria sem confiar no StuartClient . Ele permite que você use pontos de extremidade que ainda não estejam disponíveis no StuartClient e aprecie o StuartAuthenticator .

 $ apiResponse = $ httpClient -> performGet ( ' /v2/jobs?page=1 ' );
$ apiResponse -> success ();
$ apiResponse -> getBody ();

Expandir