Download the PHP package kattatzu/ship-it without Composer
On this page you can find all versions of the php package kattatzu/ship-it. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kattatzu/ship-it
More information about kattatzu/ship-it
Files in kattatzu/ship-it
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package ship-it
ShipIt
Librería que permite la integración con el API de ShipIt (https://developers.shipit.cl/docs) para enviar solicitudes de despacho, consultar su estados y otras acciones.
Obtener las Credenciales de Acceso
Para usar el API de ShipIt debes tener una cuenta y acceder al menú "API" para copiar tu email y token de acceso.
https://clientes.shipit.cl/settings/api
Instalación
Para instalar la librería ejecuta el siguiente comando en la consola:
Instalación y Uso en Laravel
Uso de forma Standalone
Si tu sistema no trabaja con Laravel puedes usarlo de forma directa:
Acciones Disponibles
Obtener las Regiones y Comunas
Puedes listar las regiones y comunas que tiene registradas ShipIt para sincronizar tu sistema.
Ejemplo
Obtener una Cotización
Puedes enviar los datos de tu despacho y obtener una cotización con las opciones de cariers que dispone ShipIt.
Para esto es necesario que crees una instancia QuotationRequest para ser enviada al método getQuotation.
Ejemplo
Si prefieres trabajar los items como array lo puedes hacer usando el método toArray()
Obtener la Cotización más Económica
Puedes enviar los datos de tu despacho y obtener la cotización más económica.
Ejemplo
Obtener la Cotización más Conveniente
Puedes obtener la cotización más conveniente tanto en tiempo de respuesta (SLA) como en precio.
Ejemplo
Enviar una solicitud de Despacho
Para enviar una solicitud de despacho debes crear una instancia ShippingRequest para ser enviada al método requestShipping:
Puedes trabajarlo como array usando el método toArray():
Listar Solicitudes de Despacho
Puedes consultar el historial de solicitudes realizadas por día usando el método getAllShippings:
Puedes trabajar el resultado como array usando el método toArray():
Obtener el detalle de un Despacho
Puedes consultar los datos de un despacho historico enviando el id entregado por ShipIt usando el método getShipping:
Utilidades
Obtener la url de seguimiento
Puede generar la url de seguimiento de un despacho fácilmente:
Tamaño aproximado del envio
Puedes obtener el tamaño aproximado en el formato que utiliza ShipIt de un paquete.
Instalación y Uso en Laravel
Después de hacer la instalación con Composer debes registrar el ServiceProvider y el alias en tu archivo config/app.php:
Publica el archivo de configuración ejecutando en Artisan:
Ya puedes ingresar las credenciales en el archivo config/shipit.php o en en archivo .env con las keys:
Facades
Ya puedes usar el Facade para acceder de forma rápida a las funciones:
Helpers
También puedes utilizar los helpers:
Callback
ShipIt nos envia dos callback, una para notificarnos que una solicitud ha sido registrada y otra que indica que se le asigno un código de seguimiento o cambio en sus estados.
La librería permite escuchar dos eventos para recibir estos callbacks y realizar las operaciones que correspondan.
Los eventos son:
- Kattatzu\ShipIt\Events\ShipItCallbackPostEvent: nos indica que una solicitud fue registrada
- Kattatzu\ShipIt\Events\ShipItCallbackPutEvent: nos indica que una solicitud fue actualizada
Instalación
Lo primero que debemos hacer es crear los EventListeners que escucharán a estos eventos y registrarlos en el EventServiceProvider (app/Providers/EventServiceProvider.php).
Una vez definidos los EventListeners podrás apuntar el Webhook de ShipIt (http://clientes.shipit.cl/settings/api) a la url:
https://tudominio.cl/callback/shipit
Puedes personalizar este endpoint en el archivo de configuración shipit.php o en tu archivo .env con la key SHIPIT_CALLBACK_URL.
No dudes en enviarme tus feedbacks o pull-request para mejorar esta librería.
Licencia
MIT License
Copyright (c) 2017 José Eduardo Ríos
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
