PHPackages                             elysium/api - 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. [API Development](/categories/api)
4. /
5. elysium/api

ActiveLibrary[API Development](/categories/api)

elysium/api
===========

API moderna e futurista para integração com o sistema Elysium

v1.1.6(1y ago)010MITPHPPHP >=7.4

Since Feb 8Pushed 1y ago1 watchersCompare

[ Source](https://github.com/ElysiumXGestor/elysium-api)[ Packagist](https://packagist.org/packages/elysium/api)[ RSS](/packages/elysium-api/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (1)Versions (8)Used By (0)

Elysium API - PHP
=================

[](#elysium-api---php)

API moderna e futurista para integração com o sistema Elysium.

Instalação via Composer
-----------------------

[](#instalação-via-composer)

```
composer require elysium/api
```

Configuração Inicial
--------------------

[](#configuração-inicial)

Para começar a usar a API, você precisa inicializar com suas credenciais:

```
use Elysium\Api\ElysiumApi;

$api = new ElysiumApi([
    'email' => 'seu-email@exemplo.com',
    'hash' => 'seu-hash-de-autenticacao'
]);
```

Autenticação
------------

[](#autenticação)

A autenticação é realizada através de dois parâmetros essenciais:

- `email`: Seu email cadastrado no sistema Elysium
- `hash`: Sua chave de autenticação fornecida pelo sistema

    **IMPORTANTE**: Mantenha suas credenciais em segurança! Nunca as exponha em código público.

Recursos Principais
-------------------

[](#recursos-principais)

- Interface moderna e intuitiva
- Suporte completo às funcionalidades do Elysium
- Tratamento de erros robusto
- Documentação completa
- Compatível com PHP 7.4+

Exemplos de Uso
---------------

[](#exemplos-de-uso)

### Criar Cliente

[](#criar-cliente)

```
try {
    $cliente = $api->createClient([
        'nome' => 'Fernando',
        'numero' => '000000000',
        'plano_id' => '264',
        'email_cliente' => 'teste@gmail.com',
        'vencimento' => '2025-10-31',
        'observacao' => 'Observação' // opcional
    ]);
    print_r($cliente);
} catch (Exception $error) {
    echo "Erro: " . $error->getMessage();
}
```

### Deletar Cliente

[](#deletar-cliente)

Duas formas de deletar um cliente:

```
// Por número
$deletarPorNumero = $api->deleteClient([
    'identificador_tipo' => 'numero',
    'identificador_valor' => '11987654321'
]);

// Por email
$deletarPorEmail = $api->deleteClient([
    'identificador_tipo' => 'email',
    'identificador_valor' => 'teste@exemplo.com'
]);
```

### Consultar Cliente

[](#consultar-cliente)

```
try {
    $cliente = $api->getClient([
        'identificador_tipo' => 'numero',
        'identificador_valor' => '1198654321'
    ]);
    print_r($cliente);
} catch (Exception $error) {
    echo "Erro: " . $error->getMessage();
}
```

### Listar Clientes

[](#listar-clientes)

```
try {
    $clientes = $api->listClients([
        'status' => 'vencidos',    // opcional
        'search' => 'cliente 1',    // opcional
        'page' => 1,               // opcional
        'limit' => 10              // opcional
    ]);
    print_r($clientes);
} catch (Exception $error) {
    echo "Erro: " . $error->getMessage();
}
```

### Enviar Mensagem

[](#enviar-mensagem)

```
try {
    // Mensagem de texto
    $mensagemTexto = $api->sendSingleMessage([
        'identificador_tipo' => 'email',
        'identificador_valor' => 'cliente@exemplo.com',
        'mensagem' => 'Olá! Como vai?',
        'tipo' => '1',    // 1 = texto
        'delay' => '1'    // velocidade (0 a 5)
    ]);

    // Mensagem com imagem
    $mensagemImagem = $api->sendSingleMessage([
        'identificador_tipo' => 'numero',
        'identificador_valor' => '11987654321',
        'mensagem' => 'Veja nossa promoção!',
        'tipo' => '2',    // 2 = imagem
        'delay' => '1',
        'imagem' => 'data:image/png;base64,...'
    ]);
} catch (Exception $error) {
    echo "Erro: " . $error->getMessage();
}
```

### Mensagem em Massa

[](#mensagem-em-massa)

```
try {
    $envioMassa = $api->sendMessagePlan([
        'plano_id' => '264',
        'mensagem' => 'Mensagem para todos!',
        'tipo' => '1',
        'delay' => '0'
    ]);
    print_r($envioMassa);
} catch (Exception $error) {
    echo "Erro: " . $error->getMessage();
}
```

### Gerenciar Planos

[](#gerenciar-planos)

```
try {
    // Criar plano
    $novoPlan = $api->createPlan([
        'nome' => 'Plano Premium',
        'valor' => 100,
        'duracao' => 30,
        'hora_disparo' => '00:00'
    ]);

    // Atualizar plano
    $planoAtualizado = $api->updatePlan('266', [
        'nome' => 'Plano Premium 2.0',
        'valor' => 100,
        'duracao' => 30,
        'hora_disparo' => '00:00'
    ]);

    // Listar planos
    $planos = $api->listPlans([
        'search' => 'premium',
        'page' => 1,
        'limit' => 10
    ]);
} catch (Exception $error) {
    echo "Erro: " . $error->getMessage();
}
```

Velocidades de Envio
--------------------

[](#velocidades-de-envio)

DelayTempo de Envio010-20 segundos120-30 segundos230-40 segundos340-50 segundos450-60 segundos560-70 segundosRequisitos
----------

[](#requisitos)

- PHP 7.4 ou superior
- Extensão cURL habilitada
- Composer

###  Health Score

26

—

LowBetter than 41% of packages

Maintenance40

Moderate activity, may be stable

Popularity5

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 90.9% 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 ~0 days

Total

7

Last Release

510d ago

### Community

Maintainers

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

---

Top Contributors

[![frasico](https://avatars.githubusercontent.com/u/142157888?v=4)](https://github.com/frasico "frasico (10 commits)")[![ElysiumXGestor](https://avatars.githubusercontent.com/u/170976418?v=4)](https://github.com/ElysiumXGestor "ElysiumXGestor (1 commits)")

### Embed Badge

![Health badge](/badges/elysium-api/health.svg)

```
[![Health](https://phpackages.com/badges/elysium-api/health.svg)](https://phpackages.com/packages/elysium-api)
```

###  Alternatives

[statamic/cms

The Statamic CMS Core Package

4.8k3.6M984](/packages/statamic-cms)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3741.3M47](/packages/tencentcloud-tencentcloud-sdk-php)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k656.1k38](/packages/neuron-core-neuron-ai)[avalara/avataxclient

Client library for Avalara's AvaTax suite of business tax calculation and processing services. Uses the REST v2 API.

528.5M7](/packages/avalara-avataxclient)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

273.0k](/packages/eslazarev-wildberries-sdk)[files.com/files-php-sdk

Files.com PHP SDK

2481.1k](/packages/filescom-files-php-sdk)

PHPackages © 2026

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