Download the PHP package amphibee/marius-api without Composer
On this page you can find all versions of the php package amphibee/marius-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download amphibee/marius-api
More information about amphibee/marius-api
Files in amphibee/marius-api
Package marius-api
Short Description Laravel package for Marius API integration
License MIT
Informations about the package marius-api
Marius API Package
A Laravel package for easy interaction with the Marius Application API.
๐ Table of Contents
- Installation
- Configuration
- Usage
- Campus
- Courses
- Applications
- Testing
- Error Handling
- Contributing
- License
๐ Installation
Requirements
- PHP 8.1 or higher
- Laravel 9.0 or higher
Via Composer
The package will be automatically discovered by Laravel. The following Facades will be registered:
Campus
Formation
Candidature
โ๏ธ Configuration
-
Publish the configuration file:
- Configure your environment variables in your
.env
file:
๐ Usage
First, import the Facades you need:
Campus
Retrieve and manage campus information:
Courses
Manage course information by campus:
Applications
Submit and manage student applications:
Example in a Controller
Here's a complete example of using the Facades in a Laravel controller:
๐งช Testing
The package includes a comprehensive test suite. When testing your own application, you can mock the Facades:
โ Error Handling
All Facade methods can throw MariusApiException
. It's recommended to wrap calls in try-catch blocks:
๐ Advanced Usage
Working with DTOs
The package uses Data Transfer Objects (DTOs) to ensure type safety and validation:
Logging API Responses
The package includes built-in logging capabilities for debugging purposes. Each service provides a getRawResponse()
method that returns the raw API response:
To enable API logging, add this to your config/logging.php
:
The logs will be stored in storage/logs/api.log
with this format:
๐งช Testing
The package includes a comprehensive test suite using Pest. To run the tests:
โ Error Handling
The package uses a custom MariusApiException
for error handling. All methods can throw this exception in case of API errors.
๐ค Contributing
Contributions are welcome! Feel free to:
- Fork the project
- Create your feature branch (
git checkout -b feature/AmazingFeature
) - Commit your changes (
git commit -m 'Add some AmazingFeature'
) - Push to the branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Make sure to update tests as appropriate.
Development Setup
- Clone the repository
- Install dependencies:
composer install
- Run tests:
./vendor/bin/pest
Coding Standards
This package follows PSR-12 coding standards. Before submitting a PR, please ensure your code follows these standards by running:
๐ License
This package is licensed under the MIT License. See the LICENSE file for details.
๐ข About AmphiBee
Developed and maintained by AmphiBee. For more information about our services or other open-source projects, please visit our website.
๐ Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
โญ Support
If you find this package helpful, please consider starring it on GitHub. For professional support or custom development needs, contact us at [email protected].
๐ Documentation
For detailed documentation of the Marius API itself, please refer to the official API documentation provided by your institution.
Additional Resources
All versions of marius-api with dependencies
illuminate/support Version ^9.0|^10.0
spatie/data-transfer-object Version ^3.0
guzzlehttp/guzzle Version ^7.9