Download the PHP package cyberfusion/oxxa-api-client without Composer

On this page you can find all versions of the php package cyberfusion/oxxa-api-client. 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?

Example code of cyberfusion/oxxa-api-client

Informations about the package oxxa-api-client

Oxxa API client

PHP client for the Oxxa API.

Support

This client was written by Cyberfusion. It has been open sourced for the community. If you have any questions, open an issue on GitHub or email [email protected].

This client is not supported by Oxxa.

Requirements

This client requires PHP 8.1 or higher with default PHP modules.

Installation

This client can be used in any PHP project and with any framework.

Install the client with Composer:

Usage

Getting started

Test mode

To test your implementation, use the test mode. All requests tell the Oxxa API that the request is a test.

Enable:

Disable:

Mock server

When testing with a mock server, you will be able to modify the base URL of the API with:

This will return the Oxxa instance, so you can chain it with other methods.

Exceptions

In case of errors, the client throws exceptions using the OxxaException as base class. All exceptions have a specific code. These can be found in the OxxaException class.

Tests

Unit tests are available in the tests directory. Run:

composer test

To generate a code coverage report in the build/report directory, run:

composer test-coverage

Contribution

Some basic endpoints are implemented, but there are a lot which are not implemented yet. Feel free to contribute! See the contributing guidelines.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

License

This client is open-sourced software licensed under the MIT license.

All versions of oxxa-api-client with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
ext-dom Version *
ext-libxml Version *
ext-simplexml Version *
guzzlehttp/guzzle Version ^7.0
illuminate/http Version ^9.0|^10.0|^11.0
illuminate/support Version ^9.0|^10.0|^11.0
symfony/css-selector Version ^6.0
symfony/dom-crawler Version ^6.0
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 cyberfusion/oxxa-api-client contains the following files

Loading the files please wait ....