Download the PHP package memurame/abacus-php-rest-api without Composer

On this page you can find all versions of the php package memurame/abacus-php-rest-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?

Example code of memurame/abacus-php-rest-api

Informations about the package abacus-php-rest-api

Abacus PHP REST API

This repository addresses the Abacus REST API and thus simplifies the handling of requests. This was developed by me for my own purposes. You are also welcome to use it yourself and help develop it further.

This repository is still in its infancy. It will therefore not yet have many functions.

Requirements

Install

How to use the API client

Example code

You can find example code within the directory examples.

The Client object

Your starting point is the AbacusClient object:

Fetching all Resource object

To read all objects without filtering:

Fetching a single Resource object

To read a single objects by Id:

Query builder

You have the option to include various queries with the request. You can attach any of these functions to a request. As an example, I have listed all possible queries for you

filter

You can search for a key and its value. You can see how the string is structured in the link below https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter

limit

You can specify how many results you want. Does not work together with all() https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop

order

Define which key to sort by and in which direction. https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby

select

Define which values you want back. The ID is always included. https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect

expand

You can attach related entities here. https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand

all

Abacus does not output all data records, it works with [@odata.nextLink]. As long as @odata.nextLink exists, it has data records that can still be retrieved. A request is made with the all() function until all data records have been retrieved.

Get all Values of the object

To get all available Values of the Address:

This returns an array of all data.

Get a single value of the object

Returns a single value based on its key:

This returns an string.

Change values

Set a new value for one or more keys.

Save changes

Saves the changes made with getValue or getValues.

create new object

Available resource types and their access methods

To be able to use the 'short form' for the resource type, add a

to your code. You then can reference the resource type like

Resource type Category Expand Implemented & tested
ACCOUNTDOCUMENTS Finance Account, Storage ✔
ACCOUNTS Finance Currency, Enterprise, ReferenceAccount, Documents ✔
ADDRESSES CRM Subject ✔
COMMUNICATIONS CRM Link, Subject ✔
COSTCENTREDOCUMENTS Finance CostCentre, Storage ✔
COSTCENTRES Finance Enterprise, Documents ✔
GENERALLEDGERENTRIES Finance CrossDivisionHeader, FollowUpHeader,CollectiveHeader, Division, Journal, AccrualHeader, CrossDivisionPositions, FollowUpPositions, CollectivePositions, AccrualPositions, Documents ✔
GENERALLEDGERENTRYDOCUMENTS Finance GeneralLedgerEntry, Storage ✔
JOURNALS Finance Enterprise, GeneralLedgerEntries ✔
LINKDOCUMENTS CRM Link, Storage ✔
LINKTYPES CRM Links ✔
LINKS CRM TargetSubject, LinkType, SourceSubject, Communications, Documents, SubjectGroupingEntries ✔
SUBJECTDOCUMENTS CRM Subject, Storage ✔
SUBJECTGROUPINGENTRIES CRM ContactPersonReference, SubjectReference, ContainingSubjectGrouping ✔
SUBJECTGROUPINGS CRM Entries ✔
SUBJECTS CRM Projects, BeneficiaryAccounts, Divisions, Enterprises, Customers, CustomerInvoicesForReminder, CustomerInvoicesForSubject, Employee, Addresses, Communications, TargetLinks, SourceLinks, Documents, SubjectGroupingEntries ✔

All versions of abacus-php-rest-api with dependencies

PHP Build Version
Package Version
Requires guzzlehttp/guzzle Version ^7.9
symfony/cache Version ^7.1
vlucas/phpdotenv Version ^5.6
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 memurame/abacus-php-rest-api contains the following files

Loading the files please wait ...