Download the PHP package pedroquezado/correios without Composer
On this page you can find all versions of the php package pedroquezado/correios. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pedroquezado/correios
More information about pedroquezado/correios
Files in pedroquezado/correios
Package correios
Short Description Biblioteca para integração com os Correios
License MIT
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 correios
Correios API Client - PedroQuezado
Introduction
This package provides an easy-to-use PHP client for interacting with the Correios API. It allows you to fetch pricing and delivery times for different products offered by Correios.
Installation
First, you need to add the package to your project using Composer.
Usage
Initialize the Client
To initialize the Cliente class, you need to provide your Correios API credentials (username and password), the card number, and an optional fourth parameter to specify the environment (production or homologation). By default, the client uses the production environment.
Example
- correios_usuario: Your Correios API username.
- correios_senha_key: Your Correios API password.
- numero_cartao_postagem: Your Correios card number.
- producao (optional): Boolean flag to specify the environment. Use
truefor production (default) andfalsefor homologation.
Adding Products
The inserirProduto method allows you to add products to the client for further operations, such as price and delivery time calculations. The method accepts two parameters: $coProduto and an array $arrProduto containing the product details.
Parameters
- $coProduto: This is the product code (e.g., '03220' for SEDEX or '03298' for PAC). It is crucial for identifying the product type in subsequent operations.
- $arrProduto: An associative array containing the product details, including:
- nuRequisicao: Request number.
- cepOrigem: Origin postal code.
- cepDestino: Destination postal code.
- psObjeto: Object weight in grams.
- tpObjeto: Object type (e.g., '1' for Box/Package).
- comprimento: Object length in centimeters.
- largura: Object width in centimeters.
- altura: Object height in centimeters.
- servicosAdicionais: Array of additional services (e.g., ["001", "019"]).
- vlDeclarado: Declared value.
- dtEvento: Event date (DD/MM/YYYY).
Example
Importance in Other Methods
The $coProduto parameter is essential for the consultarPrecoTotal and consultarPrazoTotal methods. These methods use $coProduto to filter and calculate the total price or delivery time for the specified product type. By organizing products with $coProduto, you can easily manage and retrieve detailed information for specific product types.
Fetching Prices
You can fetch the prices for the added products using the consultarPreco method.
Fetching Delivery Time
The consultarPrazo method allows you to calculate the delivery time for your products. It takes four parameters:
- $dataPostagem: The posting date in the format YYYY-MM-DD.
- $cepOrigem: The origin postal code.
- $cepDestino: The destination postal code.
- $dtEvento: (Optional) The event date in the format DD-MM-YYYY. If not provided, it defaults to the posting date converted to the required format.
Example
Parameters Explanation
- $dataPostagem: The date when the package is sent. It is essential for calculating the estimated delivery time.
- $cepOrigem: The postal code from where the package is sent.
- $cepDestino: The postal code to where the package is being delivered.
- $dtEvento: This parameter is optional. If not provided, the method will automatically set it to the value of
$dataPostagemformatted as DD-MM-YYYY. It represents the date of the event related to the delivery.
By calling consultarPrazo, you can obtain the estimated delivery time and other related information for each product you have added. The method returns detailed delivery time information, which can be used to inform customers about their expected delivery dates.
Fetching Total Price
You can fetch the total price for a specific product code using the consultarPrecoTotal method.
Fetching Total Delivery Time
You can fetch the total delivery time for a specific product code using the consultarPrazoTotal method.
Exception Handling
All exceptions are handled using the ClienteException class. This class provides additional information such as the HTTP code and the response from the API.
Documentation
For more detailed information, please refer to the official Correios API documentation:
- Correios API Documentation (requires login)
- Manual para Integração Correios API (PDF)
Conclusion
This package simplifies the process of interacting with the Correios API by providing a structured and easy-to-use client. It supports fetching prices and delivery times for various products, handling authentication, and providing detailed error handling.
