Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mvdnbrk/laravel-myparcel
MyParcel API client for Laravel
https://github.com/mvdnbrk/laravel-myparcel
api laravel myparcel
Last synced: about 1 month ago
JSON representation
MyParcel API client for Laravel
- Host: GitHub
- URL: https://github.com/mvdnbrk/laravel-myparcel
- Owner: mvdnbrk
- License: mit
- Created: 2019-11-15T13:31:51.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2020-12-18T13:36:16.000Z (about 4 years ago)
- Last Synced: 2024-11-10T16:53:11.770Z (about 2 months ago)
- Topics: api, laravel, myparcel
- Language: PHP
- Homepage:
- Size: 62.5 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# MyParcel API client for Laravel
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Tests][ico-tests]][link-tests]
[![StyleCI][ico-style-ci]][link-style-ci]
[![Total Downloads][ico-downloads]][link-downloads]
This package incorporates the [MyParcel API client](https://github.com/mvdnbrk/myparcel-php-api) into your Laravel project.
## Installation
You can install the package via composer:
```bash
composer require mvdnbrk/laravel-myparcel
```
## Configuration
All you need to do is add your MyParcel API key to the `.env` file:
```
MYPARCEL_API_KEY=YOUR-API-KEY
```
## Usage
```php
use Mvdnbrk\Laravel\Facades\MyParcel;
$shipment = MyParcel::shipments()->create([
...
]);
```
* [Full documentation for the MyParcel API client](https://github.com/mvdnbrk/myparcel-php-api)
### Global helper method
For your convenience this package provides a global `myparcel()` helper function.
```php
myparcel()->shipments()->create([
...
]);
```
## Testing
``` bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Mark van den Broek][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/mvdnbrk/laravel-myparcel.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-tests]: https://img.shields.io/github/workflow/status/mvdnbrk/laravel-dhlparcel/tests/main?label=tests&style=flat-square
[ico-style-ci]: https://styleci.io/repos/221930206/shield?branch=main
[ico-downloads]: https://img.shields.io/packagist/dt/mvdnbrk/laravel-myparcel.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/mvdnbrk/laravel-myparcel
[link-tests]: https://github.com/mvdnbrk/laravel-myparcel/actions?query=workflow%3Atests
[link-style-ci]: https://styleci.io/repos/221930206
[link-downloads]: https://packagist.org/packages/mvdnbrk/laravel-myparcel
[link-author]: https://github.com/mvdnbrk
[link-contributors]: ../../contributors