# Elysium API - Python
API moderna e futurista para integração com o sistema Elysium.
## Instalação
```bash
pip install elysium-api
```
## Configuração Inicial
```python
from elysium_api import ElysiumApi
# Inicialização da API
api = ElysiumApi({
"email": "seu-email@exemplo.com",
"hash": "seu-hash-de-autenticacao"
})
```
## Gerenciamento de Clientes
### Criar Cliente
```python
# Exemplo de criação de cliente
cliente = api.create_client({
"nome": "Fernando",
"numero": "5532999999999",
"plano_id": "264",
"email_cliente": "teste@gmail.com",
"vencimento": "2025-10-31",
"observacao": "Observação opcional"
})
```
### Atualizar Cliente
```python
# Atualização mínima
atualizacao = api.update_client({
"identificador_tipo": "numero",
"identificador_valor": "5532999999999",
"vencimento": "2025-10-31",
"plano_id": "265"
})
# Atualização completa
atualizacao_completa = api.update_client({
"identificador_tipo": "numero",
"identificador_valor": "5532999999999",
"nome": "Fernando Silva",
"email_cliente": "novo@email.com",
"vencimento": "2025-10-31",
"plano_id": "265",
"observacao": "Nova observação"
})
```
### Obter Cliente
```python
# Buscar cliente por número
cliente = api.get_client(
identificador_tipo="numero",
identificador_valor="5532999999999"
)
# Buscar cliente por email
cliente = api.get_client(
identificador_tipo="email",
identificador_valor="cliente@email.com"
)
```
### Deletar Cliente
```python
# Deletar por número
delete_numero = api.delete_client({
"identificador_tipo": "numero",
"identificador_valor": "5532999999999"
})
# Deletar por email
delete_email = api.delete_client({
"identificador_tipo": "email",
"identificador_valor": "cliente@email.com"
})
```
### Listar Clientes
```python
# Listar todos os clientes
clientes = api.list_clients()
# Listar com filtros
clientes_filtrados = api.list_clients(
status="ativos",
search="Fernando",
page=1,
limit=10
)
```
## Mensagens
### Enviar Mensagem Individual
O método `send_single_message` permite enviar mensagens personalizadas para um cliente específico, suportando texto e imagens:
```python
# Enviar mensagem de texto
mensagem = api.send_single_message({
"identificador_tipo": "email",
"identificador_valor": "cliente@exemplo.com",
"mensagem": "Olá, tudo bem?",
"tipo": "1", # tipo 1 = texto
"delay": "1" # velocidade de envio (0 a 5)
})
# Enviar mensagem com imagem
mensagem_imagem = api.send_single_message({
"identificador_tipo": "numero",
"identificador_valor": "5532999999999",
"mensagem": "Confira nossa promoção!",
"tipo": "2", # tipo 2 = imagem
"delay": "1",
"imagem": "data:image/png;base64,..." # sua imagem em base64
})
```
#### Parâmetros para Envio de Mensagem
| Parâmetro | Tipo | Descrição | Obrigatório |
| ------------------- | ------ | ----------------------------------------------------- | ------------- |
| identificador_tipo | string | Tipo de identificação ('email' ou 'numero') | Sim |
| identificador_valor | string | Email ou número do cliente | Sim |
| mensagem | string | Texto da mensagem | Sim |
| tipo | string | Tipo de mensagem ('1' = texto, '2' = imagem) | Sim |
| delay | string | Velocidade de envio (0 = mais rápido, 5 = mais lento) | Sim |
| imagem | string | Imagem em formato base64 (apenas quando tipo = '2') | Condicional\* |
> \*O parâmetro `imagem` é obrigatório apenas quando `tipo = '2'` (mensagem com imagem)
#### Velocidades de Envio (delay)
| Valor | Velocidade |
| ----- | ---------------- |
| 0 | 10 a 20 segundos |
| 1 | 20 a 30 segundos |
| 2 | 30 a 40 segundos |
| 3 | 40 a 50 segundos |
| 4 | 50 a 60 segundos |
| 5 | 60 a 70 segundos |
### Enviar Mensagem para Plano
O método `send_message_plan` permite enviar mensagens para todos os clientes de um plano específico:
```python
# Enviar mensagem de texto para plano
mensagem_plano = api.send_message_plan({
"plano_id": "264",
"mensagem": "Mensagem para todos os clientes do plano!",
"tipo": "1", # 1 para texto, 2 para imagem
"delay": "0", # 0 para mais rápido, 5 para mais lento
})
# Enviar mensagem com imagem para plano
mensagem_plano_imagem = api.send_message_plan({
"plano_id": "264",
"mensagem": "Confira nossa promoção especial!",
"tipo": "2",
"delay": "0",
"imagem": "data:image/png;base64,..." # sua imagem em base64
})
```
#### Parâmetros para Mensagem em Plano
| Parâmetro | Tipo | Descrição | Obrigatório |
| --------- | ------ | ----------------------------------------------------- | ------------- |
| plano_id | string | ID do plano | Sim |
| mensagem | string | Texto da mensagem | Sim |
| tipo | string | Tipo de mensagem ('1' = texto, '2' = imagem) | Sim |
| delay | string | Velocidade de envio (0 = mais rápido, 5 = mais lento) | Sim |
| imagem | string | Imagem em formato base64 (apenas quando tipo = '2') | Condicional\* |
> \*O parâmetro `imagem` é obrigatório apenas quando `tipo = '2'` (mensagem com imagem)
## Planos
### Criar Plano
```python
plano = api.create_plan({
"nome": "Plano Premium",
"valor": 100,
"duracao": 30,
"hora_disparo": "00:00"
})
```
### Atualizar Plano
```python
plano_atualizado = api.update_plan("266", {
"nome": "Plano Premium 2.0",
"valor": 100,
"duracao": 30,
"hora_disparo": "00:00"
})
```
### Listar Planos
```python
# Listar todos os planos
planos = api.list_plans()
# Listar com filtros
planos_filtrados = api.list_plans(
search="premium",
page=1,
limit=10
)
```
## Tratamento de Erros
A biblioteca utiliza exceções Python para tratamento de erros. Sempre utilize try/except:
```python
try:
resultado = api.create_client({...})
except Exception as error:
print("Erro:", error)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "elysium-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "elysium, api, mensagens, clientes, planos",
"author": "Elysium API",
"author_email": "contato@elysiumx.com.br",
"download_url": "https://files.pythonhosted.org/packages/8a/02/b832bfe8bcd17edd4973617a9461efb44044ff9f798dcf1ceaa246f27f9b/elysium_api-1.1.9.tar.gz",
"platform": null,
"description": "# Elysium API - Python\r\n\r\nAPI moderna e futurista para integra\u00e7\u00e3o com o sistema Elysium.\r\n\r\n## Instala\u00e7\u00e3o\r\n\r\n```bash\r\npip install elysium-api\r\n```\r\n\r\n## Configura\u00e7\u00e3o Inicial\r\n\r\n```python\r\nfrom elysium_api import ElysiumApi\r\n\r\n# Inicializa\u00e7\u00e3o da API\r\napi = ElysiumApi({\r\n \"email\": \"seu-email@exemplo.com\",\r\n \"hash\": \"seu-hash-de-autenticacao\"\r\n})\r\n```\r\n\r\n## Gerenciamento de Clientes\r\n\r\n### Criar Cliente\r\n\r\n```python\r\n# Exemplo de cria\u00e7\u00e3o de cliente\r\ncliente = api.create_client({\r\n \"nome\": \"Fernando\",\r\n \"numero\": \"5532999999999\",\r\n \"plano_id\": \"264\",\r\n \"email_cliente\": \"teste@gmail.com\",\r\n \"vencimento\": \"2025-10-31\",\r\n \"observacao\": \"Observa\u00e7\u00e3o opcional\"\r\n})\r\n```\r\n\r\n### Atualizar Cliente\r\n\r\n```python\r\n# Atualiza\u00e7\u00e3o m\u00ednima\r\natualizacao = api.update_client({\r\n \"identificador_tipo\": \"numero\",\r\n \"identificador_valor\": \"5532999999999\",\r\n \"vencimento\": \"2025-10-31\",\r\n \"plano_id\": \"265\"\r\n})\r\n\r\n# Atualiza\u00e7\u00e3o completa\r\natualizacao_completa = api.update_client({\r\n \"identificador_tipo\": \"numero\",\r\n \"identificador_valor\": \"5532999999999\",\r\n \"nome\": \"Fernando Silva\",\r\n \"email_cliente\": \"novo@email.com\",\r\n \"vencimento\": \"2025-10-31\",\r\n \"plano_id\": \"265\",\r\n \"observacao\": \"Nova observa\u00e7\u00e3o\"\r\n})\r\n```\r\n\r\n### Obter Cliente\r\n\r\n```python\r\n# Buscar cliente por n\u00famero\r\ncliente = api.get_client(\r\n identificador_tipo=\"numero\",\r\n identificador_valor=\"5532999999999\"\r\n)\r\n\r\n# Buscar cliente por email\r\ncliente = api.get_client(\r\n identificador_tipo=\"email\",\r\n identificador_valor=\"cliente@email.com\"\r\n)\r\n```\r\n\r\n### Deletar Cliente\r\n\r\n```python\r\n# Deletar por n\u00famero\r\ndelete_numero = api.delete_client({\r\n \"identificador_tipo\": \"numero\",\r\n \"identificador_valor\": \"5532999999999\"\r\n})\r\n\r\n# Deletar por email\r\ndelete_email = api.delete_client({\r\n \"identificador_tipo\": \"email\",\r\n \"identificador_valor\": \"cliente@email.com\"\r\n})\r\n```\r\n\r\n### Listar Clientes\r\n\r\n```python\r\n# Listar todos os clientes\r\nclientes = api.list_clients()\r\n\r\n# Listar com filtros\r\nclientes_filtrados = api.list_clients(\r\n status=\"ativos\",\r\n search=\"Fernando\",\r\n page=1,\r\n limit=10\r\n)\r\n```\r\n\r\n## Mensagens\r\n\r\n### Enviar Mensagem Individual\r\n\r\nO m\u00e9todo `send_single_message` permite enviar mensagens personalizadas para um cliente espec\u00edfico, suportando texto e imagens:\r\n\r\n```python\r\n# Enviar mensagem de texto\r\nmensagem = api.send_single_message({\r\n \"identificador_tipo\": \"email\",\r\n \"identificador_valor\": \"cliente@exemplo.com\",\r\n \"mensagem\": \"Ol\u00e1, tudo bem?\",\r\n \"tipo\": \"1\", # tipo 1 = texto\r\n \"delay\": \"1\" # velocidade de envio (0 a 5)\r\n})\r\n\r\n# Enviar mensagem com imagem\r\nmensagem_imagem = api.send_single_message({\r\n \"identificador_tipo\": \"numero\",\r\n \"identificador_valor\": \"5532999999999\",\r\n \"mensagem\": \"Confira nossa promo\u00e7\u00e3o!\",\r\n \"tipo\": \"2\", # tipo 2 = imagem\r\n \"delay\": \"1\",\r\n \"imagem\": \"data:image/png;base64,...\" # sua imagem em base64\r\n})\r\n```\r\n\r\n#### Par\u00e2metros para Envio de Mensagem\r\n\r\n| Par\u00e2metro | Tipo | Descri\u00e7\u00e3o | Obrigat\u00f3rio |\r\n| ------------------- | ------ | ----------------------------------------------------- | ------------- |\r\n| identificador_tipo | string | Tipo de identifica\u00e7\u00e3o ('email' ou 'numero') | Sim |\r\n| identificador_valor | string | Email ou n\u00famero do cliente | Sim |\r\n| mensagem | string | Texto da mensagem | Sim |\r\n| tipo | string | Tipo de mensagem ('1' = texto, '2' = imagem) | Sim |\r\n| delay | string | Velocidade de envio (0 = mais r\u00e1pido, 5 = mais lento) | Sim |\r\n| imagem | string | Imagem em formato base64 (apenas quando tipo = '2') | Condicional\\* |\r\n\r\n> \\*O par\u00e2metro `imagem` \u00e9 obrigat\u00f3rio apenas quando `tipo = '2'` (mensagem com imagem)\r\n\r\n#### Velocidades de Envio (delay)\r\n\r\n| Valor | Velocidade |\r\n| ----- | ---------------- |\r\n| 0 | 10 a 20 segundos |\r\n| 1 | 20 a 30 segundos |\r\n| 2 | 30 a 40 segundos |\r\n| 3 | 40 a 50 segundos |\r\n| 4 | 50 a 60 segundos |\r\n| 5 | 60 a 70 segundos |\r\n\r\n### Enviar Mensagem para Plano\r\n\r\nO m\u00e9todo `send_message_plan` permite enviar mensagens para todos os clientes de um plano espec\u00edfico:\r\n\r\n```python\r\n# Enviar mensagem de texto para plano\r\nmensagem_plano = api.send_message_plan({\r\n \"plano_id\": \"264\",\r\n \"mensagem\": \"Mensagem para todos os clientes do plano!\",\r\n \"tipo\": \"1\", # 1 para texto, 2 para imagem\r\n \"delay\": \"0\", # 0 para mais r\u00e1pido, 5 para mais lento\r\n})\r\n\r\n# Enviar mensagem com imagem para plano\r\nmensagem_plano_imagem = api.send_message_plan({\r\n \"plano_id\": \"264\",\r\n \"mensagem\": \"Confira nossa promo\u00e7\u00e3o especial!\",\r\n \"tipo\": \"2\",\r\n \"delay\": \"0\",\r\n \"imagem\": \"data:image/png;base64,...\" # sua imagem em base64\r\n})\r\n```\r\n\r\n#### Par\u00e2metros para Mensagem em Plano\r\n\r\n| Par\u00e2metro | Tipo | Descri\u00e7\u00e3o | Obrigat\u00f3rio |\r\n| --------- | ------ | ----------------------------------------------------- | ------------- |\r\n| plano_id | string | ID do plano | Sim |\r\n| mensagem | string | Texto da mensagem | Sim |\r\n| tipo | string | Tipo de mensagem ('1' = texto, '2' = imagem) | Sim |\r\n| delay | string | Velocidade de envio (0 = mais r\u00e1pido, 5 = mais lento) | Sim |\r\n| imagem | string | Imagem em formato base64 (apenas quando tipo = '2') | Condicional\\* |\r\n\r\n> \\*O par\u00e2metro `imagem` \u00e9 obrigat\u00f3rio apenas quando `tipo = '2'` (mensagem com imagem)\r\n\r\n## Planos\r\n\r\n### Criar Plano\r\n\r\n```python\r\nplano = api.create_plan({\r\n \"nome\": \"Plano Premium\",\r\n \"valor\": 100,\r\n \"duracao\": 30,\r\n \"hora_disparo\": \"00:00\"\r\n})\r\n```\r\n\r\n### Atualizar Plano\r\n\r\n```python\r\nplano_atualizado = api.update_plan(\"266\", {\r\n \"nome\": \"Plano Premium 2.0\",\r\n \"valor\": 100,\r\n \"duracao\": 30,\r\n \"hora_disparo\": \"00:00\"\r\n})\r\n```\r\n\r\n### Listar Planos\r\n\r\n```python\r\n# Listar todos os planos\r\nplanos = api.list_plans()\r\n\r\n# Listar com filtros\r\nplanos_filtrados = api.list_plans(\r\n search=\"premium\",\r\n page=1,\r\n limit=10\r\n)\r\n```\r\n\r\n## Tratamento de Erros\r\n\r\nA biblioteca utiliza exce\u00e7\u00f5es Python para tratamento de erros. Sempre utilize try/except:\r\n\r\n```python\r\ntry:\r\n resultado = api.create_client({...})\r\nexcept Exception as error:\r\n print(\"Erro:\", error)\r\n```\r\n",
"bugtrack_url": null,
"license": null,
"summary": "API moderna e futurista para integra\u00e7\u00e3o com o sistema Elysium",
"version": "1.1.9",
"project_urls": null,
"split_keywords": [
"elysium",
" api",
" mensagens",
" clientes",
" planos"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1874bdc5141c7d2eab24823fd3ec9cfd5c582a9b52507370a05f352b2c690b83",
"md5": "68a76f6d18c3c9044a6afda474a3d471",
"sha256": "b98476a02dd0a3dfc1db1440cbc4cdf006d9ccca4469235c8099288f78ccc665"
},
"downloads": -1,
"filename": "elysium_api-1.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "68a76f6d18c3c9044a6afda474a3d471",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6122,
"upload_time": "2025-02-08T05:00:36",
"upload_time_iso_8601": "2025-02-08T05:00:36.424589Z",
"url": "https://files.pythonhosted.org/packages/18/74/bdc5141c7d2eab24823fd3ec9cfd5c582a9b52507370a05f352b2c690b83/elysium_api-1.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8a02b832bfe8bcd17edd4973617a9461efb44044ff9f798dcf1ceaa246f27f9b",
"md5": "9de3c276df27730fd3c9726239e243a4",
"sha256": "f50a96166116de525df469e52235037b3e879fdda31756c5d136404d4ff20cd6"
},
"downloads": -1,
"filename": "elysium_api-1.1.9.tar.gz",
"has_sig": false,
"md5_digest": "9de3c276df27730fd3c9726239e243a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5683,
"upload_time": "2025-02-08T05:00:38",
"upload_time_iso_8601": "2025-02-08T05:00:38.196268Z",
"url": "https://files.pythonhosted.org/packages/8a/02/b832bfe8bcd17edd4973617a9461efb44044ff9f798dcf1ceaa246f27f9b/elysium_api-1.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-08 05:00:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "elysium-api"
}
JSON