Download the PHP package ominity/oauth2-ominity-php without Composer

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

Ominity OAuth in PHP

This package provides Ominity OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Use Ominity OAuth to easily connect Ominity User & Admin accounts to your application.

Installation

By far the easiest way to install the Ominity API client is to require it with Composer.

$ composer require ominity/oauth2-ominity-php ^1.0

    {
        "require": {
            "ominity/oauth2-ominity-php": "^1.0"
        }
    }

You may also git checkout or download all the files, and include the OAuth 2.0 provider manually.

Usage

Usage is the same as The League's OAuth client, using \Ominity\OAuth2\Client\Provider\Ominity as the provider.

Authorization Code Flow

Refreshing A Token

Authenticating using the AccessToken (ominity-api-php example)

After refreshing an AccessToken, here's how to use it with the ominity-api-php package. Note that the getToken() method is used to obtain the access token string.

[!NOTE] In order to access the ominity api via \Ominity\Api\OminityApiClient, the ominity/ominity-api-php library is required!

Revoking a token

Both AccessTokens and RefreshTokens are revokable. Here's how to revoke an AccessToken:

Similarly, here's how to revoke a RefreshToken:

Note: When you revoke a refresh token, all access tokens based on the same authorization grant will be revoked as well.

Want to help us make our API client even better?

Want to help us make our API client even better? We take pull requests.

License

BSD (Berkeley Software Distribution) License. Copyright (c) 2024, Ominity.

Support

Contact: www.ominity.com[email protected]


All versions of oauth2-ominity-php with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8.0
league/oauth2-client Version ^2.7
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 ominity/oauth2-ominity-php contains the following files

Loading the files please wait ....