# 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
connection = Connection(
server='seu_domínio_ixc.com.br', # Também pode ser um enderço de IP
token='seu_token_ixc', # Verificar a última referência
table='su_oss_chamado', # Exemplo de requisição 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)
Raw data
{
"_id": null,
"home_page": "https://github.com/SousaFelipe/ixcpy",
"name": "ixcpy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "ixc, ixcsoft, api ixc, ixc python",
"author": "Felipe Sousa",
"author_email": "sousa.felipe@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/e2/1f/20c84f0da1dc4b2261e46c09ef8dcd0289ab85f8e54154d8e51c3332ab20/ixcpy-1.0.3.tar.gz",
"platform": null,
"description": "\r\n# ixcpy\r\n\r\nUm wrapper de conex\u00e3o com a API do IXC\r\n\r\nEsta biblioteca n\u00e3o faz parte do conjunto oficial de bibliotecas da IXCsoft!\\\r\nO desenvolvimento \u00e9 feito de forma independente e utiliza apenas as funcionalidades providas pela API oficial do IXC.\r\nTodas as funcionalidades se resumem a uma interface de comunica\u00e7\u00e3o com a API do sistema IXC.\\\r\nVoc\u00ea poder\u00e1 encontrar orienta\u00e7\u00f5es de como parametrizar as requisi\u00e7\u00f5es, na Wiki oficial da API do IXC.\r\n\r\n\r\n## Observa\u00e7\u00f5es\r\n\r\nPara estabelecer uma conex\u00e3o corretamente, \u00e9 necess\u00e1rio fornecer o token de autentica\u00e7\u00e3o da API do IXC (Link nas refer\u00eancias abaixo) e o dom\u00ednio do seu servidor IXC, nos par\u00e2metros do construtor da classe Connection.\r\n\r\nExemplo:\r\n\r\n```python\r\nconnection = Connection(\r\n server='seu_dom\u00ednio_ixc.com.br', # Tamb\u00e9m pode ser um ender\u00e7o de IP\r\n token='seu_token_ixc', # Verificar a \u00faltima refer\u00eancia\r\n table='su_oss_chamado', # Exemplo de requisi\u00e7\u00e3o na tabela de Ordens de Servi\u00e7o\r\n ...\r\n)\r\n```\r\n\r\n\r\n## Clone & Setup\r\n\r\n```bash\r\ngit clone https://github.com/SousaFelipe/ixcpy.git\r\n```\r\n```bash\r\ncd ixcpy\r\n```\r\n```bash\r\npython -m venv .venv\r\n```\r\n```bash\r\n.venv\\Scripts\\activate\r\n```\r\n```bash\r\npython -m pip install -r requirements.txt\r\n```\r\n\r\n\r\n## Refer\u00eancias\r\n\r\n - [Site da IXCsoft](https://ixcsoft.com/)\r\n - [Wiki oficial da API do IXC](https://wikiapiprovedor.ixcsoft.com.br/)\r\n - [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)\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Wrapper n\u00e3o oficial da API do IXC",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/SousaFelipe/ixcpy"
},
"split_keywords": [
"ixc",
" ixcsoft",
" api ixc",
" ixc python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e21f20c84f0da1dc4b2261e46c09ef8dcd0289ab85f8e54154d8e51c3332ab20",
"md5": "42da1fcb116e5df864f39d5f95a09e13",
"sha256": "979103df82cf52efb7772f1f143bee1300a6665e580ad9b866c1db6a7ec544fc"
},
"downloads": -1,
"filename": "ixcpy-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "42da1fcb116e5df864f39d5f95a09e13",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4382,
"upload_time": "2024-07-18T00:05:41",
"upload_time_iso_8601": "2024-07-18T00:05:41.743133Z",
"url": "https://files.pythonhosted.org/packages/e2/1f/20c84f0da1dc4b2261e46c09ef8dcd0289ab85f8e54154d8e51c3332ab20/ixcpy-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-18 00:05:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SousaFelipe",
"github_project": "ixcpy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "ixcpy"
}
JSON
