# Vezor SDK Python
[](https://python.org)
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/py/vezor-sdk)
SDK oficial da Vezor para integração com APIs de comunicação e CRM. Este pacote Python fornece interfaces simples e intuitivas para trabalhar com a EvoAPI e Kommo CRM.
## Instalação
```bash
pip install vezor-sdk
```
## Requisitos
- Python 3.8 ou superior
- requests >= 2.31.0
## Módulos Disponíveis
### VzrClient - Cliente Base
Cliente genérico para APIs da Vezor com funcionalidades básicas de autenticação e requisições.
### EvoApiClient - Integração EvoAPI
Cliente especializado para integração com a EvoAPI, oferecendo métodos para gerenciar contatos, clientes e mensagens.
### KommoApiClient - Integração Kommo CRM
Cliente para integração com o Kommo CRM v4, permitindo gerenciar pipelines, status, tags e webhooks.
## Uso
### VzrClient - Cliente Base
```python
from vezor_sdk import VzrClient
# Inicializar cliente
client = VzrClient(
base_url="https://api.vezor.cloud",
api_key="sua_api_key_aqui"
)
# Teste de conexão
response = client.ping()
print(response)
# Buscar dados de um recurso
data = client.get_data("usuarios")
print(data)
```
### EvoApiClient - Integração EvoAPI
```python
from vezor_sdk import EvoApiClient
# Inicializar cliente EvoAPI
evo_client = EvoApiClient(
base_url="https://evoapi.vezor.cloud",
instance="sua_instancia",
api_key="sua_api_key"
)
# Obter contatos
contatos = evo_client.get_contacts()
print(f"Total de contatos: {len(contatos)}")
# Obter contatos e salvar em arquivo
contatos = evo_client.get_contacts(save_path="contatos.json")
# Obter clientes com filtros
filtros = {"status": "ativo"}
clientes = evo_client.get_clients(filters=filtros)
# Obter todas as mensagens
mensagens = evo_client.get_messages(save_path="mensagens.json")
print(f"Total de mensagens: {len(mensagens)}")
```
### KommoApiClient - Integração Kommo CRM
```python
from vezor_sdk import KommoApiClient
# Inicializar cliente Kommo
kommo_client = KommoApiClient(
base_url="https://minhaempresa.kommo.com",
token="seu_token_oauth2"
)
# Obter pipelines
pipelines = kommo_client.get_pipelines()
for pipeline in pipelines:
print(f"Pipeline: {pipeline['name']} (ID: {pipeline['id']})")
# Obter status de um pipeline
statuses = kommo_client.get_pipeline_statuses(pipeline_id=12345)
# Gerenciar tags
tags = kommo_client.get_lead_tags()
nova_tag = kommo_client.create_lead_tag("Nova Tag", "FF0000")
# Gerenciar webhooks
webhooks = kommo_client.get_webhooks()
novo_webhook = kommo_client.create_webhook(
destination="https://meusite.com/webhook",
settings=["lead_add", "lead_update"]
)
```
## Autenticação
### VzrClient
- **API Key**: Token Bearer para autenticação
- **Base URL**: URL base da API Vezor
### EvoApiClient
- **API Key**: Chave de API específica da EvoAPI
- **Instance**: ID da instância
- **Base URL**: URL base da EvoAPI
### KommoApiClient
- **Token**: Token OAuth2 do Kommo
- **Base URL**: URL da sua conta Kommo (ex: https://minhaempresa.kommo.com)
## Exemplos Avançados
### Processamento de Mensagens em Lote
```python
from vezor_sdk import EvoApiClient
evo_client = EvoApiClient(
base_url="https://evoapi.vezor.cloud",
instance="minha_instancia",
api_key="minha_api_key"
)
# Obter mensagens com paginação personalizada
mensagens = evo_client.get_messages(offset=5000)
# Filtrar mensagens por tipo
mensagens_texto = [msg for msg in mensagens if msg.get('type') == 'text']
print(f"Mensagens de texto: {len(mensagens_texto)}")
```
### Gerenciamento Completo de Pipeline Kommo
```python
from vezor_sdk import KommoApiClient
kommo_client = KommoApiClient(
base_url="https://minhaempresa.kommo.com",
token="meu_token"
)
# Obter informações completas do pipeline
pipelines = kommo_client.get_pipelines()
for pipeline in pipelines:
print(f"\n=== {pipeline['name']} ===")
statuses = kommo_client.get_pipeline_statuses(pipeline['id'])
for status in statuses:
print(f" - {status['name']}: {status['color']}")
```
## Desenvolvimento
### Instalação para Desenvolvimento
```bash
git clone https://github.com/vezor-group/vezor_sdk.git
cd vezor_sdk
pip install -e .
```
### Executando Testes
```bash
python -m pytest tests/
```
## Changelog
Veja o [CHANGELOG.md](CHANGELOG.md) para histórico de versões e mudanças.
## Contribuindo
Contribuições são bem-vindas! Por favor, leia nossas diretrizes de contribuição antes de enviar pull requests.
1. Fork o projeto
2. Crie uma branch para sua feature (`git checkout -b feature/AmazingFeature`)
3. Commit suas mudanças (`git commit -m 'Add some AmazingFeature'`)
4. Push para a branch (`git push origin feature/AmazingFeature`)
5. Abra um Pull Request
## Licença
Este projeto está licenciado sob a Licença MIT - veja o arquivo [LICENSE](LICENSE) para detalhes.
## Suporte
- **Email**: admin.platform@vezor.com.br
- **Documentação**: [GitHub Wiki](https://github.com/vezor-group/vezor_sdk/wiki)
- **Issues**: [GitHub Issues](https://github.com/vezor-group/vezor_sdk/issues)
**Sobre a Vezor Technology**
Somos uma empresa de tecnologia comprometida com o **desenvolvimento democrático e acessível** de soluções inovadoras. Acreditamos que a tecnologia deve ser uma ferramenta de transformação social, capaz de resolver problemas reais e criar oportunidades equitativas para todos.
Nossa missão é democratizar o acesso a tecnologias avançadas, desenvolvendo soluções que sejam **simples de usar**, **economicamente acessíveis** e **tecnicamente robustas**. Trabalhamos com **Inteligência Artificial**, **integrações de sistemas**, **plataformas web e mobile**, sempre priorizando a **inclusão digital** e o **impacto social positivo**.
Apoiamos o desenvolvimento de **ecossistemas tecnológicos abertos** e **colaborativos**, onde desenvolvedores, empresas e comunidades possam crescer juntos. Nossas ferramentas e SDKs são criados para facilitar a adoção de tecnologias emergentes, reduzindo barreiras técnicas e econômicas.
**Conheça nosso Manifesto:** [https://about.vezor.cloud/](https://about.vezor.cloud/)
---
**Desenvolvido pela equipe Vezor LABs**
Raw data
{
"_id": null,
"home_page": "https://github.com/vezor-group/vezor_sdk",
"name": "vezor-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Breno Leone",
"author_email": "Breno Leone <admin.platform@vezor.com.br>",
"download_url": "https://files.pythonhosted.org/packages/7e/7e/3cc2dd0633e138ce1151cf44d435dec81f3d5805e838475781bceaece486/vezor_sdk-0.1.2.tar.gz",
"platform": null,
"description": "# Vezor SDK Python\n\n[](https://python.org)\n[](https://opensource.org/licenses/MIT)\n[](https://badge.fury.io/py/vezor-sdk)\n\nSDK oficial da Vezor para integra\u00e7\u00e3o com APIs de comunica\u00e7\u00e3o e CRM. Este pacote Python fornece interfaces simples e intuitivas para trabalhar com a EvoAPI e Kommo CRM.\n\n## Instala\u00e7\u00e3o\n\n```bash\npip install vezor-sdk\n```\n\n## Requisitos\n\n- Python 3.8 ou superior\n- requests >= 2.31.0\n\n## M\u00f3dulos Dispon\u00edveis\n\n### VzrClient - Cliente Base\nCliente gen\u00e9rico para APIs da Vezor com funcionalidades b\u00e1sicas de autentica\u00e7\u00e3o e requisi\u00e7\u00f5es.\n\n### EvoApiClient - Integra\u00e7\u00e3o EvoAPI\nCliente especializado para integra\u00e7\u00e3o com a EvoAPI, oferecendo m\u00e9todos para gerenciar contatos, clientes e mensagens.\n\n### KommoApiClient - Integra\u00e7\u00e3o Kommo CRM\nCliente para integra\u00e7\u00e3o com o Kommo CRM v4, permitindo gerenciar pipelines, status, tags e webhooks.\n\n## Uso\n\n### VzrClient - Cliente Base\n\n```python\nfrom vezor_sdk import VzrClient\n\n# Inicializar cliente\nclient = VzrClient(\n base_url=\"https://api.vezor.cloud\",\n api_key=\"sua_api_key_aqui\"\n)\n\n# Teste de conex\u00e3o\nresponse = client.ping()\nprint(response)\n\n# Buscar dados de um recurso\ndata = client.get_data(\"usuarios\")\nprint(data)\n```\n\n### EvoApiClient - Integra\u00e7\u00e3o EvoAPI\n\n```python\nfrom vezor_sdk import EvoApiClient\n\n# Inicializar cliente EvoAPI\nevo_client = EvoApiClient(\n base_url=\"https://evoapi.vezor.cloud\",\n instance=\"sua_instancia\",\n api_key=\"sua_api_key\"\n)\n\n# Obter contatos\ncontatos = evo_client.get_contacts()\nprint(f\"Total de contatos: {len(contatos)}\")\n\n# Obter contatos e salvar em arquivo\ncontatos = evo_client.get_contacts(save_path=\"contatos.json\")\n\n# Obter clientes com filtros\nfiltros = {\"status\": \"ativo\"}\nclientes = evo_client.get_clients(filters=filtros)\n\n# Obter todas as mensagens\nmensagens = evo_client.get_messages(save_path=\"mensagens.json\")\nprint(f\"Total de mensagens: {len(mensagens)}\")\n```\n\n### KommoApiClient - Integra\u00e7\u00e3o Kommo CRM\n\n```python\nfrom vezor_sdk import KommoApiClient\n\n# Inicializar cliente Kommo\nkommo_client = KommoApiClient(\n base_url=\"https://minhaempresa.kommo.com\",\n token=\"seu_token_oauth2\"\n)\n\n# Obter pipelines\npipelines = kommo_client.get_pipelines()\nfor pipeline in pipelines:\n print(f\"Pipeline: {pipeline['name']} (ID: {pipeline['id']})\")\n\n# Obter status de um pipeline\nstatuses = kommo_client.get_pipeline_statuses(pipeline_id=12345)\n\n# Gerenciar tags\ntags = kommo_client.get_lead_tags()\nnova_tag = kommo_client.create_lead_tag(\"Nova Tag\", \"FF0000\")\n\n# Gerenciar webhooks\nwebhooks = kommo_client.get_webhooks()\nnovo_webhook = kommo_client.create_webhook(\n destination=\"https://meusite.com/webhook\",\n settings=[\"lead_add\", \"lead_update\"]\n)\n```\n\n## Autentica\u00e7\u00e3o\n\n### VzrClient\n- **API Key**: Token Bearer para autentica\u00e7\u00e3o\n- **Base URL**: URL base da API Vezor\n\n### EvoApiClient\n- **API Key**: Chave de API espec\u00edfica da EvoAPI\n- **Instance**: ID da inst\u00e2ncia\n- **Base URL**: URL base da EvoAPI\n\n### KommoApiClient\n- **Token**: Token OAuth2 do Kommo\n- **Base URL**: URL da sua conta Kommo (ex: https://minhaempresa.kommo.com)\n\n## Exemplos Avan\u00e7ados\n\n### Processamento de Mensagens em Lote\n\n```python\nfrom vezor_sdk import EvoApiClient\n\nevo_client = EvoApiClient(\n base_url=\"https://evoapi.vezor.cloud\",\n instance=\"minha_instancia\",\n api_key=\"minha_api_key\"\n)\n\n# Obter mensagens com pagina\u00e7\u00e3o personalizada\nmensagens = evo_client.get_messages(offset=5000)\n\n# Filtrar mensagens por tipo\nmensagens_texto = [msg for msg in mensagens if msg.get('type') == 'text']\nprint(f\"Mensagens de texto: {len(mensagens_texto)}\")\n```\n\n### Gerenciamento Completo de Pipeline Kommo\n\n```python\nfrom vezor_sdk import KommoApiClient\n\nkommo_client = KommoApiClient(\n base_url=\"https://minhaempresa.kommo.com\",\n token=\"meu_token\"\n)\n\n# Obter informa\u00e7\u00f5es completas do pipeline\npipelines = kommo_client.get_pipelines()\nfor pipeline in pipelines:\n print(f\"\\n=== {pipeline['name']} ===\")\n statuses = kommo_client.get_pipeline_statuses(pipeline['id'])\n for status in statuses:\n print(f\" - {status['name']}: {status['color']}\")\n```\n\n## Desenvolvimento\n\n### Instala\u00e7\u00e3o para Desenvolvimento\n\n```bash\ngit clone https://github.com/vezor-group/vezor_sdk.git\ncd vezor_sdk\npip install -e .\n```\n\n### Executando Testes\n\n```bash\npython -m pytest tests/\n```\n\n## Changelog\n\nVeja o [CHANGELOG.md](CHANGELOG.md) para hist\u00f3rico de vers\u00f5es e mudan\u00e7as.\n\n## Contribuindo\n\nContribui\u00e7\u00f5es s\u00e3o bem-vindas! Por favor, leia nossas diretrizes de contribui\u00e7\u00e3o antes de enviar pull requests.\n\n1. Fork o projeto\n2. Crie uma branch para sua feature (`git checkout -b feature/AmazingFeature`)\n3. Commit suas mudan\u00e7as (`git commit -m 'Add some AmazingFeature'`)\n4. Push para a branch (`git push origin feature/AmazingFeature`)\n5. Abra um Pull Request\n\n## Licen\u00e7a\n\nEste projeto est\u00e1 licenciado sob a Licen\u00e7a MIT - veja o arquivo [LICENSE](LICENSE) para detalhes.\n\n## Suporte\n\n- **Email**: admin.platform@vezor.com.br\n- **Documenta\u00e7\u00e3o**: [GitHub Wiki](https://github.com/vezor-group/vezor_sdk/wiki)\n- **Issues**: [GitHub Issues](https://github.com/vezor-group/vezor_sdk/issues)\n\n**Sobre a Vezor Technology**\n\nSomos uma empresa de tecnologia comprometida com o **desenvolvimento democr\u00e1tico e acess\u00edvel** de solu\u00e7\u00f5es inovadoras. Acreditamos que a tecnologia deve ser uma ferramenta de transforma\u00e7\u00e3o social, capaz de resolver problemas reais e criar oportunidades equitativas para todos.\n\nNossa miss\u00e3o \u00e9 democratizar o acesso a tecnologias avan\u00e7adas, desenvolvendo solu\u00e7\u00f5es que sejam **simples de usar**, **economicamente acess\u00edveis** e **tecnicamente robustas**. Trabalhamos com **Intelig\u00eancia Artificial**, **integra\u00e7\u00f5es de sistemas**, **plataformas web e mobile**, sempre priorizando a **inclus\u00e3o digital** e o **impacto social positivo**.\n\nApoiamos o desenvolvimento de **ecossistemas tecnol\u00f3gicos abertos** e **colaborativos**, onde desenvolvedores, empresas e comunidades possam crescer juntos. Nossas ferramentas e SDKs s\u00e3o criados para facilitar a ado\u00e7\u00e3o de tecnologias emergentes, reduzindo barreiras t\u00e9cnicas e econ\u00f4micas.\n\n**Conhe\u00e7a nosso Manifesto:** [https://about.vezor.cloud/](https://about.vezor.cloud/)\n\n---\n\n**Desenvolvido pela equipe Vezor LABs**\n",
"bugtrack_url": null,
"license": null,
"summary": "Bridge Python SDK da Vezor",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/vezor-group/vezor_sdk"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "eacde8388f5665dd952a03445240e96b91ca07d3e6c81375ea608cb22c670abb",
"md5": "2a212ab286c4ea3f0ee83012eb3bc5c1",
"sha256": "a5d28a89d7216fb0b489d2af82704012e94e11e4a1a3708c2370a90883960a99"
},
"downloads": -1,
"filename": "vezor_sdk-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a212ab286c4ea3f0ee83012eb3bc5c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7693,
"upload_time": "2025-09-06T15:33:32",
"upload_time_iso_8601": "2025-09-06T15:33:32.464783Z",
"url": "https://files.pythonhosted.org/packages/ea/cd/e8388f5665dd952a03445240e96b91ca07d3e6c81375ea608cb22c670abb/vezor_sdk-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7e7e3cc2dd0633e138ce1151cf44d435dec81f3d5805e838475781bceaece486",
"md5": "15147b8df7eb89073f8a86932a8d6308",
"sha256": "a82404f48bc3dc1b9575b3f806fcf4d12ec159216f0ba88ed0a98efbf4d48fbd"
},
"downloads": -1,
"filename": "vezor_sdk-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "15147b8df7eb89073f8a86932a8d6308",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9386,
"upload_time": "2025-09-06T15:33:33",
"upload_time_iso_8601": "2025-09-06T15:33:33.463043Z",
"url": "https://files.pythonhosted.org/packages/7e/7e/3cc2dd0633e138ce1151cf44d435dec81f3d5805e838475781bceaece486/vezor_sdk-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-06 15:33:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vezor-group",
"github_project": "vezor_sdk",
"github_not_found": true,
"lcname": "vezor-sdk"
}
JSON
