Download the PHP package ocolin/billmax without Composer

On this page you can find all versions of the php package ocolin/billmax. 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 ocolin/billmax

Informations about the package billmax

Billmax API Client

Table of Contents

What is it?

This is a small lightweight PHP client for using the REST API service of Billmax billing software.

Requirements

Installation

Todo

Configuration

Settings

The client can be configured by either environment variables, constructor arguments, or a combination of both, Here is a list of the settings needed for configuration.

Environment Constructor Description
BILLMAX_API_KEY $apiKey API Key to access server
BILLMAX_API_HOST $host Hostname and URI of API server
BILLMAX_API_AUTH $auth Authentication mode
BILLMAX_API_USERNAME $username Username for USERPASS mode
BILLMAX_API_PASSWORD $password Password for USERPASS mode
BILLMAX_API_OAUTH2_CLIENT_ID $clientId Client ID for OAuth2 mode
BILLMAX_API_OAUTH2_CLIENT_SECRET $clientSecret Client secret for OAuth2 mode

Authentication mode.

The Billmax REST API has 3 authentication modes:

Configuring with Environment variables.

Configuring with constructor

The Billmax client uses a Config object class to hold settings. You can configure this by creating a Config object.

Guzzle HTTP options.

This client uses Guzzle to handle HTTP calls and allows for extra options to be specified in the Config object.

Response

The Billmax client will return a response object with the following properties:

Property name Type Description
status int The HTTP status code (200,401, etc)
statusMessage string The HTTP status message
headers array HTTP response headers
body object|array HTTP response body, json decoded

Function Parameters

parameter method type description
endpoint ALL string Endpoint URI path. Any variable tokens will get replaced with matching kesy in query array/object
method N/A string HTTP method to use in the request() method
query ALL array|object URI path and query parameters. Keys that match {tokens} in URI will ne interpolated into the URI path
body POST/PATCH array|object HTTP body in array or object format.
autoGet PATCH boolean Automatically get the stored generation value of row to be updated in Billmax. If the generation value changed from the time you check to the time you patch, an error will be thrown

Method functions

GET

POST

PATCH

DELETE

Request method

Also included is a generic function without a specific HTTP method.

Filter

The Billmax API has a query parameter that allows requests to be filtered. This class is to make creating filters easier by putting them in function calls rather than typing out a filter query.

A filter can have multiple conditions and each condiction consists of a field (a column in the database), an operator, and a value. The Filter allows these to be stacked together.

Condition format

Example

Condition functions

Function name Description
where start condition
also add additional condition
build build the query into a string

Operator functions

Function name Value type Description
eq string|int|float equals
ne string|int|float not equals
like string like
nlike string not like
in array in []
nin array not in []
has array has []
nhas array does not have []
gt string|int|float greater than
lt string|int|float less than
gte string|int|float greater than or equal
lte string|int|float less than or equal
ft string fulltextindex - match against
ftb string fulltextindex - in boolean mode
ftq string fulltextindex - with query expansion

Getting your API key.

The api ksy is part of your billmax remove application and was generated when you set up the remote application. Locating your API Key:

Uploading

Because uploading files works much different from the rest of endpoints, a specific function as been created to handle file uploading.

Upload arguments

Argument type description
entity string Entity to attach file. Ex: account, ticket, message, service, etc.
entityId integer The ID of entity to attach to. Ex: account 1, ticket 3, service 1, etc.
filePaths array An array of file arrays. See table below for file path values.

File Path Properties

Each file takes an array of values:

Property Name Type Descrition
path string Path to and including the file to upload.
class string Billmax file class to use. Default is 'support'
description string A description of the file for display purposes

Example

All versions of billmax with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
ocolin/global-type Version ^2.0
guzzlehttp/guzzle Version ^7.10
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 ocolin/billmax contains the following files

Loading the files please wait ...