Download the PHP package tiago_alves/licen-sys_conector_packpage without Composer
On this page you can find all versions of the php package tiago_alves/licen-sys_conector_packpage. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tiago_alves/licen-sys_conector_packpage
More information about tiago_alves/licen-sys_conector_packpage
Files in tiago_alves/licen-sys_conector_packpage
Package licen-sys_conector_packpage
Short Description Metodos e controle de conexão com gerenciador de licenças LicenSys
License proprietary
Informations about the package licen-sys_conector_packpage
LicenSys Conector Packpage
Pacote Laravel para integração com a API LicenSys.
Instalação
Configuração
1. Variáveis de Ambiente
Adicione ao arquivo .env:
2. Registrar o Provider
O provider já está registrado em bootstrap/providers.php:
3. Publicar Configuração (Opcional)
Arquitetura dos Serviços
Configuração da API
| Parâmetro | Variável de Ambiente | Descrição |
|---|---|---|
api_url |
LICENSYS_API_URL |
URL base da API LicenSys |
api_key_crypt |
LICENSYS_API_KEY |
Chave de API para autenticação |
Serviços
1. ConectorService
Namespace: TiagoAlves\LicenSysConectorPackpage\Services\ConectorService
Descrição: Gerencia a conexão inicial e autenticação com a API. Utiliza credenciais estáticas (URL e API Key).
Métodos
| Método | Parâmetros | Retorno | Descrição |
|---|---|---|---|
getUrlApi() |
- | string |
Retorna a URL da API |
setUrlApi(string $urlApi, bool $overwrite = false) |
$urlApi, $overwrite |
void |
Define a URL da API |
getApiKey() |
- | string |
Retorna a API Key |
setApiKey(string $apiKey, bool $overwrite = false) |
$apiKey, $overwrite |
void |
Define a API Key |
checkUrl() |
- | bool |
Verifica se a URL da API está acessível |
connect(string $uuid) |
$uuid |
array |
Conecta à API com o UUID da empresa |
revokeMyTokens(string $uuid) |
$uuid |
array |
Revoga os tokens da sessão |
Uso
2. LicenseManagerService
Namespace: TiagoAlves\LicenSysConectorPackpage\Services\LicenseManagerService
Descrição: Gerencia operações relacionadas a licenças e dados de empresas. Requer Bearer Token válido (obtido via ConectorService::connect()).
Construtor
| Parâmetro | Tipo | Descrição |
|---|---|---|
$bearerToken |
string |
Token de autenticação Bearer |
Métodos
| Método | Parâmetros | Retorno | Endpoint API |
|---|---|---|---|
getDataLicense(string $company_uuid) |
$company_uuid - UUID da empresa |
array |
GET /license_manager/getDataLicense |
getMonths(string $company_uuid, int $month = 0, string\|int $year = 'all', string\|array $monthly_fee = 'all') |
$company_uuid, $month, $year, $monthly_fee |
array |
GET /license_manager/getMonths |
Uso
3. TransferService
Namespace: TiagoAlves\LicenSysConectorPackpage\Services\TransferService
Descrição: Gerencia transferências e operações de PIX. Requer Bearer Token válido.
Construtor
| Parâmetro | Tipo | Descrição |
|---|---|---|
$bearerToken |
string |
Token de autenticação Bearer |
Métodos
| Método | Parâmetros | Retorno | Endpoint API |
|---|---|---|---|
send($company_uuid, $historic_company_id, $pix_origin_name, $file) |
$company_uuid, $historic_company_id, $pix_origin_name, $file (UploadFile) |
array |
POST /transfer/proccess |
getQrCodePix(int $historic_company_id) |
$historic_company_id |
array |
GET /transfer/getQrCodePix |
Uso
Fluxo de Autenticação
Endpoints da API
| Serviço | Método | Endpoint | Descrição |
|---|---|---|---|
| Conector | POST | /connect |
Autentica e obtém Bearer Token |
| Conector | POST | /revokeMyTokens |
Revoga tokens da sessão |
| Conector | GET | /check-api |
Verifica disponibilidade da API |
| LicenseManager | GET | /license_manager/getDataLicense |
Obtém dados da licença |
| LicenseManager | GET | /license_manager/getMonths |
Obtém meses/anos de licença |
| Transfer | POST | /transfer/proccess |
Envia transferência com arquivo |
| Transfer | GET | /transfer/getQrCodePix |
Obtém QR Code PIX |
Exceptions
| Serviço | Exception | Condição |
|---|---|---|
| ConectorService | \Exception |
API URL não configurada |
| ConectorService | \Exception |
API Key não configurada |
| LicenSysHttpUtils | \Exception |
Bearer Token não definido |