Download the PHP package uccello/uccello-api without Composer

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

Informations about the package uccello-api

Install package

Config JWT

Publish the config

Run the following command to publish the package config file:

You should now have a config/jwt.php file that allows you to configure the basics of this package.

Generate secret key

I have included a helper command to generate a key for you:

This will update your .env file with something like JWT_SECRET=foobar

It is the key that will be used to sign your tokens. How that happens exactly will depend on the algorithm that you choose to use.

Update your User model

Firstly you need to implement the Tymon\JWTAuth\Contracts\JWTSubject contract on your User model, which requires that you implement the 2 methods getJWTIdentifier() and getJWTCustomClaims().

The example below should give you an idea of how this could look. Obviously you should make any changes, as necessary, to suit your own needs.

Configure Auth guard

Note: This will only work if you are using Laravel 5.2 and above.

Inside the config/auth.php file you will need to make a few changes to configure Laravel to use the jwt guard to power your application authentication.

Make the following changes to the file:

Here we are telling the api guard to use the jwt driver, and we are setting the api guard as the default.

We can now use Laravel's built in Auth system, with jwt-auth doing the work behind the scenes!

Config CORS

The provided Spatie\Cors\Cors middleware must be registered in the global middleware group.

Config

You can add this parameters to config/uccello.php:

Daily usage

You can pass several params to the request URL:

Param Description Default Example
descendants Activate (1) or not (0) descendant view according to the user's roles. 0 &descendants=1
select Semicolon separated list of columns to retrieve. &select=name;created_at
order Semicolon and comma separated list of the order clauses. &order=name,asc;email,desc
with Semicolon separated list of the relations to add in the response. &with=domain;clients
length Pagination length. 100 &length=300

All versions of uccello-api with dependencies

PHP Build Version
Package Version
Requires laravel/sanctum Version ^2.9
uccello/uccello Version 2.*
darkaonline/l5-swagger Version ^8.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 uccello/uccello-api contains the following files

Loading the files please wait ....