PHPackages                             ativabot/php-sdk - 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. ativabot/php-sdk

ActiveLibrary

ativabot/php-sdk
================

SDK oficial em PHP para integração com a API Externa do AtivaBot CRM

00PHP

Since Aug 2Pushed todayCompare

[ Source](https://github.com/VisionTaubate/ativabot-SDK)[ Packagist](https://packagist.org/packages/ativabot/php-sdk)[ RSS](/packages/ativabot-php-sdk/feed)WikiDiscussions temp Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

AtivaBot SDK para PHP e Laravel
===============================

[](#ativabot-sdk-para-php-e-laravel)

[![Software License](https://camo.githubusercontent.com/074b89bca64d3edc93a1db6c7e3b1636b874540ba91d66367c0e5e354c56d0ea/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e737667)](LICENSE)[![PHP Version](https://camo.githubusercontent.com/8875b4d77856d8a794900c39a6d05313b9513e30d9cda13f07c26b0ab9a63ed9/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344253230372e342d626c75652e737667)](https://php.net)

SDK Oficial em PHP para integração com a API Externa do **AtivaBot CRM**. Permite enviar mensagens de texto e mídia via WhatsApp, gerenciar contatos, grupos, templates WABA e receber webhooks com suporte nativo a PHP puro e Laravel.

- 🌐 **Site Oficial:**
- 👤 **Área do Usuário:**

---

🚀 Instalação
------------

[](#-instalação)

Instale o pacote via Composer:

```
composer require ativabot/php-sdk
```

---

🔑 Como Obter suas Credenciais (API ID e Token)
----------------------------------------------

[](#-como-obter-suas-credenciais-api-id-e-token)

Para utilizar o SDK, você precisará do **API ID** e do **Token (JWT)** gerados no painel do **AtivaBot CRM**:

1. Acesse o painel do **AtivaBot CRM** ().
2. No menu lateral esquerdo, acesse **Sistema** ➔ **API** (ou vá diretamente para `/api-service`).
3. Clique no botão **"Adicionar"** no canto superior direito.
4. Preencha as informações da integração:
    - **Nome da API**: Um nome para identificar seu sistema (ex.: `Meu Sistema PHP`, `E-commerce`).
    - **Enviar por**: Selecione a conexão de WhatsApp padrão que realizará os disparos.
    - **WebHook** *(Opcional)*: Caso queira receber notificações de eventos (mensagens recebidas, status de entrega, contatos, etc.), preencha a URL do seu Webhook e selecione os eventos desejados.
5. Clique em **Salvar**.
6. Na lista de integrações cadastradas (ou ao abrir a edição da API), copie facilmente as duas credenciais:
    - **API ID**: Clique no botão de copiar (ícone 📋) no campo **API ID** (ou no cabeçalho do card).
    - **Token (JWT)**: Clique no botão de copiar (ícone 📋) no campo **Token (JWT)**.

---

⚙️ Configuração no Laravel
--------------------------

[](#️-configuração-no-laravel)

Se você estiver utilizando Laravel, o pacote possui **Package Auto-Discovery** e registrará o Service Provider e a Facade automaticamente.

Para publicar o arquivo de configuração `config/ativabot.php`:

```
php artisan vendor:publish --tag="ativabot-config"
```

Em seguida, adicione suas credenciais no arquivo `.env`:

```
ATIVABOT_API_ID=seu-api-id-uuid
ATIVABOT_JWT_TOKEN=seu-jwt-token-aqui
```

---

💻 Uso em PHP Puro
-----------------

[](#-uso-em-php-puro)

```
use AtivaBot\Client;

$client = Client::create(
    'seu-api-id-uuid',
    'seu-jwt-token'
);

// Enviar mensagem de texto
$response = $client->messages()->sendText(
    '5511999999999',
    'Olá! Mensagem enviada via SDK AtivaBot em PHP puro.'
);

// Enviar arquivo de mídia (imagem/PDF/áudio)
$mediaResponse = $client->messages()->sendMedia(
    '5511999999999',
    '/caminho/para/documento.pdf',
    'Legenda da mídia',
    'minha_chave_externa_123'
);
```

---

⚡ Uso no Laravel (via Facade)
-----------------------------

[](#-uso-no-laravel-via-facade)

```
use AtivaBot\Laravel\Facades\AtivaBot;

// Enviar mensagem de texto
AtivaBot::messages()->sendText('5511999999999', 'Olá via Laravel Facade!');

// Criar um contato
AtivaBot::contacts()->create([
    'name'   => 'João Silva',
    'number' => '5511999999999',
    'email'  => 'joao@email.com'
]);

// Enviar template aprovado
AtivaBot::templates()->send([
    'to'           => '5511999999999',
    'templateName' => 'boas_vindas',
    'language'     => 'pt_BR'
]);
```

---

🔔 Tratamento de Webhooks
------------------------

[](#-tratamento-de-webhooks)

O SDK fornece o utilitário `WebhookHandler` para facilitar a interpretação dos eventos enviados pelo CRM:

```
use AtivaBot\Webhooks\WebhookHandler;

$payload = WebhookHandler::parse(); // Lê automaticamente php://input

if (WebhookHandler::isMessageStatusEvent($payload)) {
    $externalKey = $payload['externalKey'];
    $status      = $payload['status']; // delivered, read, failed
}
```

---

📚 Endpoints Disponíveis no SDK
------------------------------

[](#-endpoints-disponíveis-no-sdk)

- **`messages()`**: `sendText()`, `sendMedia()`, `sendSpecial()`
- **`contacts()`**: `list()`, `create()`, `update()`, `delete()`
- **`groups()`**: `list()`, `create()`, `update()`, `delete()`
- **`templates()`**: `list()`, `create()`, `update()`, `delete()`, `submitForApproval()`, `send()`
- **`sessions()`**: `start()`

---

📄 Licença
---------

[](#-licença)

Este SDK é um software open-source sob a licença MIT.

###  Health Score

20

↑

LowBetter than 12% of packages

Maintenance65

Regular maintenance activity

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity11

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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/21661d999379651430cbe53a923dbfc201a82a754bd487314ceb174d6ed53f1a?d=identicon)[DouglasLelis](/maintainers/DouglasLelis)

---

Top Contributors

[![DouglasLelis](https://avatars.githubusercontent.com/u/69450448?v=4)](https://github.com/DouglasLelis "DouglasLelis (5 commits)")

### Embed Badge

![Health badge](/badges/ativabot-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/ativabot-php-sdk/health.svg)](https://phpackages.com/packages/ativabot-php-sdk)
```

PHPackages © 2026

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