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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package marius-api

Marius API Package

A Laravel package for easy interaction with the Marius Application API.

๐Ÿ“‹ Table of Contents

๐Ÿš€ Installation

Requirements

Via Composer

The package will be automatically discovered by Laravel. The following Facades will be registered:

โš™๏ธ Configuration

  1. Publish the configuration file:

  2. 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:

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Make sure to update tests as appropriate.

Development Setup

  1. Clone the repository
  2. Install dependencies: composer install
  3. 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

PHP Build Version
Package Version
Requires php Version ^8.2
illuminate/support Version ^9.0|^10.0
spatie/data-transfer-object Version ^3.0
guzzlehttp/guzzle Version ^7.9
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package amphibee/marius-api contains the following files

Loading the files please wait ....