Download the PHP package axo3/api-client without Composer

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

Informations about the package api-client

axo3 API client

PHP client for the axo3 real-estate data API: fetch your stock as JSON, keep it as a local file snapshot, revalidate at the interval the API dictates. Framework-free — works in WordPress, Joomla, any CMS, or plain PHP.

You need an API key. Keys are issued per connection in the axo3 backend; the code here is free (MIT), the API access is part of your axo3 plan.

Install

With Composer:

Without Composer (WordPress, Joomla, plain PHP): download the release ZIP, unpack it anywhere in your project and load the bundled autoloader:

Requirements: PHP >= 8.2 with curl and json.

Use

Two rules the service enforces for you, and that you should not work around:

  1. Render first, ask afterwards. units(), findUnit() and tree() read the local snapshot only. revalidateIfDue() belongs after the page is built or in a background job — never inside the render path.
  2. The API dictates the pace. Every answer says when to ask again; the service stores it and revalidateIfDue() obeys it. No polling loops.

What the data looks like — fields, vocabulary, media links, ETag rules — is specified in docs/units-v1.md.

Failure behaviour

A failed fetch (network down, key revoked, API rebuilding) never breaks your page: the current snapshot stays in place and keeps being served, the attempt is logged to logFile, and the next attempt waits for the normal interval. To raise your own alert, pass a callback:

$service->health() is a keyed liveness probe for a "check connection" button in your own admin UI.

License

MIT — see LICENSE.

All versions of api-client with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
ext-curl Version *
ext-json Version *
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 axo3/api-client contains the following files

Loading the files please wait ...