Metadata-Version: 2.1
Name: ixcpy
Version: 1.0.1
Summary: Wrapper não oficial da API do IXC
Author: Felipe Sousa
Author-email: sousa.felipe@outlook.com
License: MIT License
Keywords: ixc,ixcsoft,api ixc,ixc python
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: openpyxl
Requires-Dist: pandas
Requires-Dist: requests


# ixcpy

Um wrapper de conexão com a API do IXC

Esta biblioteca não faz parte do conjunto oficial de bibliotecas da IXCsoft!\
O desenvolvimento é feito de forma independente e utiliza apenas as funcionalidades providas pela API oficial do IXC.
Todas as funcionalidades se resumem a uma interface de comunicação com a API do sistema IXC.\
Você poderá encontrar orientações de como parametrizar as requisições, na Wiki oficial da API do IXC.


## Observações

Para estabelecer uma conexão corretamente, é necessário fornecer o token de autenticação da API do IXC (Link nas referências abaixo) e o domínio do seu servidor IXC, nos parâmetros do construtor da classe Connection.

Exemplo:

```python

class Connection:
  def __init__(self, server: str, token: str, table: str, ssl: bool = False, ...):
    ...

connection = Connection(
  server='seu_domínio_ixc.com.br',  # Também pode ser Um enderço de IP, caso seu servidor IXC não possua domínio
  token='seu_token_ixc',            # Verificar a última referência a baixo
  table='su_oss_chamado',           # Exemplo de como realizar requisições na tabela de Ordens de Serviço
  ...
)
```


## Clone & Setup

```bash
git clone https://github.com/SousaFelipe/ixcpy.git
```
```bash
cd ixcpy
```
```bash
python -m venv .venv
```
```bash
.venv\Scripts\activate
```
```bash
python -m pip install -r requirements.txt
```


## Referências

  - [Site da IXCsoft](https://ixcsoft.com/)
  - [Wiki oficial da API do IXC](https://wikiapiprovedor.ixcsoft.com.br/)
  - [Tutorial de como gerar um Token de API no IXC](https://wiki.ixcsoft.com.br/pt-br/API/como_gerar_um_token_para_integra%C3%A7%C3%B5es_API)
