Download the PHP package lenra/internal-api-client without Composer

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

Informations about the package internal-api-client

OpenAPIClient-php

The API usable by the Lenra applications

For more information, please visit https://www.lenra.io/contact.html.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

Then run composer install

Manual Installation

Download the files and include autoload.php:

Getting Started

Please follow the installation procedure and then run the following:

API Endpoints

All URIs are relative to http://localhost:4001

Class Method HTTP request Description
DataApi abortTransaction POST /app-api/v1/data/transaction/abort Aborts a transaction
DataApi commitTransaction POST /app-api/v1/data/transaction/commit Commits a transaction
DataApi createDocument POST /app-api/v1/data/colls/{coll}/docs Creates a document in database
DataApi createTransaction POST /app-api/v1/data/transaction Creates a transaction
DataApi deleteCollection DELETE /app-api/v1-api/v1/data/colls/{coll} Deletes a collection from database
DataApi deleteDocumentById DELETE /app-api/v1/data/colls/{coll}/docs/{id} Deletes a document from database
DataApi findDocuments POST /app-api/v1/data/colls/{coll}/find Finds documents in database
DataApi getDocumentById GET /app-api/v1/data/colls/{coll}/docs/{id} Gets a document from database
DataApi getDocuments GET /app-api/v1/data/colls/{coll}/docs Gets documents from database
DataApi updateDocumentById PUT /app-api/v1/data/colls/{coll}/docs/{id} Updates a document in database
DataApi updateManyDocuments POST /app-api/v1/data/colls/{coll}/updateMany Updates many documents in database

Models

Authorization

Authentication schemes defined for the API:

bearerAuth

Tests

To run the tests, use:

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:


All versions of internal-api-client with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.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 lenra/internal-api-client contains the following files

Loading the files please wait ....