PHPackages                             carlostmj/uway-connect - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. carlostmj/uway-connect

ActiveLibrary[Authentication & Authorization](/categories/authentication)

carlostmj/uway-connect
======================

SDK oficial para integrar OAuth 2.0/2.1 do UWAY Auth em PHP e Laravel.

0.3.0(3mo ago)01MITPHPPHP ^8.1

Since Jan 23Pushed 3mo agoCompare

[ Source](https://github.com/carlostmj/uway-connect)[ Packagist](https://packagist.org/packages/carlostmj/uway-connect)[ RSS](/packages/carlostmj-uway-connect/feed)WikiDiscussions main Synced today

READMEChangelog (1)Dependencies (7)Versions (3)Used By (0)

UWAY Connect
============

[](#uway-connect)

SDK oficial para integrar OAuth 2.1 e OpenID Connect do **UWAY Auth** em PHP puro e Laravel.

- Fluxo Authorization Code + PKCE (OAuth 2.1)
- `client_credentials` para integrações server-to-server
- Helpers para state/PKCE
- Discovery OpenID do AUTH (`/.well-known/openid-configuration`)
- Contrato padrão de exportação de dados entre apps (`/.well-known/uway-user-export`)
- Troca de code por tokens e `userinfo`
- Integração simples no Laravel

Instalacao
----------

[](#instalacao)

```
composer require carlostmj/uway-connect
```

Fluxo completo (PHP puro)
-------------------------

[](#fluxo-completo-php-puro)

### 1) Criar instancia

[](#1-criar-instancia)

```
use CarlosTMJ\UwayConnect\Config;
use CarlosTMJ\UwayConnect\UwayConnect;

$uway = new UwayConnect(new Config(
    baseUrl: 'https://auth.uway.com.br',
    clientId: 'SEU_CLIENT_ID',
    clientSecret: null, // public client (SPA/mobile)
    redirectUri: 'https://seu-app.com/auth/uway/callback',
    defaultScopes: ['basic', 'openid']
));
```

### 2) Gerar URL de consentimento (PKCE + state)

[](#2-gerar-url-de-consentimento-pkce--state)

```
session_start();

$request = $uway->createAuthorizationRequest([
    'basic', 'openid'
]);

// guarde na sessao
$_SESSION['uway_state'] = $request->state;
$_SESSION['uway_verifier'] = $request->codeVerifier;

header('Location: '.$request->url);
exit;
```

### 2.1) Cadastro com UWAY (opcional)

[](#21-cadastro-com-uway-opcional)

```
session_start();

$request = $uway->createSignupRequest([
    'basic', 'openid'
]);

$_SESSION['uway_state'] = $request->state;
$_SESSION['uway_verifier'] = $request->codeVerifier;

header('Location: '.$request->url);
exit;
```

### 3) Callback: validar state e trocar code por token

[](#3-callback-validar-state-e-trocar-code-por-token)

```
session_start();

$tokenSet = $uway->exchangeCodeFromCallback(
    $_GET,
    $_SESSION['uway_state'] ?? '',
    $_SESSION['uway_verifier'] ?? ''
);

$user = $uway->userInfo($tokenSet->accessToken);
```

Laravel (exemplo completo)
--------------------------

[](#laravel-exemplo-completo)

### .env

[](#env)

```
UWAY_AUTH_BASE_URL=https://auth.uway.com.br
UWAY_AUTH_CLIENT_ID=...
UWAY_AUTH_CLIENT_SECRET=...
UWAY_AUTH_REDIRECT_URI=https://seu-app.com/auth/uway/callback
UWAY_AUTH_SCOPES="basic openid"

```

### Rotas

[](#rotas)

```
Route::get('/auth/uway', [UwayAuthController::class, 'redirect'])->name('uway.redirect');
Route::get('/auth/uway/signup', [UwayAuthController::class, 'signup'])->name('uway.signup');
Route::get('/auth/uway/callback', [UwayAuthController::class, 'callback'])->name('uway.callback');
```

### Controller

[](#controller)

```
use Illuminate\Http\Request;
use CarlosTMJ\UwayConnect\Laravel\UwayConnectFacade as UwayConnect;

class UwayAuthController
{
    public function redirect(Request $request)
    {
        $authRequest = UwayConnect::createAuthorizationRequest();

        $request->session()->put('uway_state', $authRequest->state);
        $request->session()->put('uway_verifier', $authRequest->codeVerifier);

        return redirect()->away($authRequest->url);
    }

    public function signup(Request $request)
    {
        $authRequest = UwayConnect::createSignupRequest();

        $request->session()->put('uway_state', $authRequest->state);
        $request->session()->put('uway_verifier', $authRequest->codeVerifier);

        return redirect()->away($authRequest->url);
    }

    public function callback(Request $request)
    {
        $tokenSet = UwayConnect::exchangeCodeFromCallback(
            $request->query(),
            (string) $request->session()->pull('uway_state'),
            (string) $request->session()->pull('uway_verifier')
        );

        $profile = UwayConnect::userInfo($tokenSet->accessToken);

        // aqui voce cria/loga o usuario
        return response()->json($profile);
    }
}
```

Dois modos de login
-------------------

[](#dois-modos-de-login)

O pacote pode ser usado de 2 formas:

- `interno`: seu app cria ou sincroniza usuario local
- `AUTH-only`: seu app usa apenas a identidade remota do UWAY AUTH

Detalhes completos:

- `docs/laravel.md`
- `docs/login-modes.md`

Discovery do AUTH
-----------------

[](#discovery-do-auth)

```
$discovery = $uway->discovery();

$discovery->accountCenterEndpoint;   // /account
$discovery->accountProfileEndpoint;  // /account/profile
$discovery->accountSecurityEndpoint; // /account/security
```

Client credentials
------------------

[](#client-credentials)

```
$tokens = $uway->clientCredentialsToken(['basic']);
```

Exportação de dados entre apps
------------------------------

[](#exportação-de-dados-entre-apps)

Quando um app conectado quiser participar da exportação unificada de dados da conta, ele deve expor:

- `/.well-known/uway-user-export`
- endpoint de início da exportação
- endpoint de status
- endpoint de manifesto
- endpoint de download de arquivo

O pacote agora inclui um builder para esse documento:

```
use CarlosTMJ\UwayConnect\ExportCapabilityDocument;

$document = ExportCapabilityDocument::make([
    'start' => '/internal/user-exports',
    'status' => '/internal/user-exports/{exportId}',
    'manifest' => '/internal/user-exports/{exportId}/manifest',
    'file' => '/internal/user-exports/{exportId}/files/{fileId}',
    'callback' => '/internal/user-exports/callbacks/auth',
]);

return response()->json($document->toArray());
```

O controller completo tambem esta disponivel em:

- `docs/examples/laravel-user-export-controller.php`

Tratamento de erros
-------------------

[](#tratamento-de-erros)

Qualquer falha gera `UwayConnectException` com:

- `statusCode`
- `payload` (dados brutos do endpoint)

```
try {
    $tokenSet = $uway->exchangeCodeFromCallback($_GET, $state, $verifier);
} catch (\CarlosTMJ\UwayConnect\UwayConnectException $e) {
    // log e tratamento
}
```

Documentacao completa
---------------------

[](#documentacao-completa)

Veja `docs/` para:

- `quickstart.md`
- `oauth-flow.md`
- `php.md`
- `laravel.md`
- `login-modes.md`
- `data-export.md`
- `security.md`

Licenca
-------

[](#licenca)

MIT

###  Health Score

31

—

LowBetter than 66% of packages

Maintenance79

Regular maintenance activity

Popularity1

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity34

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~52 days

Total

2

Last Release

109d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/61996695?v=4)[CarlosTMJ](/maintainers/carlostmj)[@carlostmj](https://github.com/carlostmj)

---

Top Contributors

[![carlostmj](https://avatars.githubusercontent.com/u/61996695?v=4)](https://github.com/carlostmj "carlostmj (11 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/carlostmj-uway-connect/health.svg)

```
[![Health](https://phpackages.com/badges/carlostmj-uway-connect/health.svg)](https://phpackages.com/packages/carlostmj-uway-connect)
```

###  Alternatives

[laravel/framework

The Laravel Framework.

34.8k543.8M20.1k](/packages/laravel-framework)[google/auth

Google Auth Library for PHP

1.4k294.2M219](/packages/google-auth)[tempest/framework

The PHP framework that gets out of your way.

2.2k34.4k15](/packages/tempest-framework)[drupal/core

Drupal is an open source content management platform powering millions of websites and applications.

21866.0M1.7k](/packages/drupal-core)[drupal/core-recommended

Locked core dependencies; require this project INSTEAD OF drupal/core.

6942.5M421](/packages/drupal-core-recommended)[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

751291.4k43](/packages/civicrm-civicrm-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)