# BarteSDK para Python
Bem-vindo ao BarteSDK para Python, a solução oficial para integração com as APIs de pagamento da Barte, projetada para simplificar e acelerar o desenvolvimento de suas aplicações . Com nosso SDK, você pode facilmente integrar funcionalidades de pagamento, assinaturas, e gestão de compradores em sua aplicação.
## Recursos do SDK
O BarteSDK fornece métodos convenientes para interagir com as seguintes APIs:
- **API de Planos**: Facilita o gerenciamento dos planos cadastrados no seu checkout.
- **API de Pedidos**: Permite gerenciar os pedidos cadastrados no seu sistema.
- **API de Compradores**: Auxilia na gestão dos compradores cadastrados.
- **API de Cobranças**: Fornece ferramentas para o gerenciamento das cobranças.
- **API de Assinaturas**: Facilita a criação e gestão de assinaturas.
## Vantagens do BarteSDK
O BarteSDK foi desenvolvido pensando na eficiência e na otimização do tempo de desenvolvimento, oferecendo uma série de vantagens que vão além da simples integração com nossas APIs. Embora seu uso não seja obrigatório, recomendamos fortemente que você o adote para aproveitar os seguintes benefícios:
- **Mais Eficiência e Redução de Custos**: Implementar nosso SDK significa reduzir custos operacionais e de desenvolvimento. Ele já está pronto para uso e totalmente homologado pela Barte, garantindo que você esteja sempre alinhado com as melhores práticas e padrões do mercado.
- **Instalação Otimizada**: Facilitamos a instalação com nossa solução plug-and-play, que se integra perfeitamente a sistemas de gestão de pacotes como Composer, Gradle, Maven e NPM. Isso agiliza significativamente a integração do SDK ao seu projeto, economizando tempo valioso de desenvolvimento.
- **Construção de Requisições Simplificada**: Simplifique a construção de suas requisições com nossa interface intuitiva. O SDK foi projetado para minimizar a complexidade, otimizar o desenvolvimento e garantir uma implementação eficaz e livre de erros.
- **Segurança de Dados**: A segurança é uma prioridade absoluta no BarteSDK. Utilizamos as melhores práticas e padrões de segurança para proteger todas as informações transmitidas, garantindo a integridade e confidencialidade dos dados dos seus clientes.
Adotar o BarteSDK não é apenas uma questão de conveniência; é uma decisão estratégica que fortalece a segurança, reduz custos e aumenta a eficiência do desenvolvimento de software na sua organização.
## Como Começar
Para começar a usar o BarteSDK, siga os passos abaixo:
1. **INSTALAÇÃO**
Instale o SDK via pip:
```bash
pip install bartesdk
2. **QUICKSTART**
Todos os requests feitos utilizando o bartesdk devem incluir alguns parâmetros comuns para garantir a autenticação e a especificação do ambiente e versão da API. Esses parâmetros são essenciais para a comunicação adequada com os serviços da Barte.
- `api_key`: Chave de API gerada no Portal do Seller em Configurações -> Integração -> Chaves API. Esta chave é utilizada para autenticar as requisições e garantir que apenas usuários autorizados possam acessar os recursos da API.
- `env`: Especifica em qual ambiente o request deverá ser feito. Os valores possíveis são: "prd" ou "sandbox".
- `api_version`: Versão da API que está sendo utilizada. Atualmente, as versões disponíveis são v1 e v2.
### Exemplo de Requisição:
```python
from bartesdk import BarteSDK
# Defina sua chave de API gerada no Portal do Seller
api_key = 'your-api-token'
# Crie uma instância da classe BarteSDK especificando o ambiente e a versão da API
api_client = BarteSDK(api_key, env="sandbox", api_version="v2")
# Faça um request para um módulo e método específicos
response = api_client.{modulo}.{metodo}(
x='y'
)
# Imprima a resposta do request
print(response)
```
3. **MÓDULOS**
### `buyers`
Gerencie os perfis dos compradores registrados no seu sistema de maneira eficiente. Este módulo permite criar novos registros, listar os existentes, atualizar informações e excluir dados conforme necessário. Facilita a administração completa dos perfis, assegurando que as informações estejam sempre atualizadas e acessíveis.
### `charges`
Gerencie as cobranças registradas no seu sistema, permitindo a criação, listagem, atualização, estorno e cancelamento de cobranças de forma eficiente e segura.
### `plans`
Gerencia os planos de pagamento cadastrados no seu sistema de checkout. Com este módulo, você pode criar novos planos, listar todos os planos cadastrados, atualizar detalhes de planos existentes e excluir planos conforme necessário. Ideal para administrar diversos tipos de planos de assinatura ou pagamento recorrente, garantindo flexibilidade e controle total sobre as opções de pagamento oferecidas aos seus clientes.
####
### `orders`
O módulo de Orders permite gerenciar pedidos registrados no seu sistema de maneira eficiente e flexível. Com ele, é possível criar novos pedidos, listar pedidos existentes, atualizar detalhes de pedidos específicos e obter informações detalhadas sobre pedidos individuais. Ele foi projetado para ser robusto e adaptável, aceitando uma ampla variedade de parâmetros que facilitam a integração e a manutenção do sistema.
####
### `subscription`
O módulo de Subscriptions permite gerenciar assinaturas no seu sistema de maneira eficiente e flexível. Com ele, você pode criar novas assinaturas, listar assinaturas existentes, atualizar detalhes de assinaturas específicas, cancelar assinaturas e obter informações detalhadas sobre assinaturas individuais. A API é projetada para ser robusta e adaptável, aceitando uma ampla variedade de parâmetros que facilitam a integração e a manutenção do sistema.
####
4. **MÉTODOS**
### `create`
Este método permite a criação de novos registros no sistema. Pode ser utilizado para adicionar novos itens, como compradores, pedidos, planos, assinaturas, entre outros. Os parâmetros necessários para a criação são passados dinamicamente, permitindo flexibilidade e fácil adaptação às mudanças no backend.
```python
response = api_client.{modulo}.create(
campo1="valor1",
campo2="valor2",
...
)
print(response)
```
### `update`
Este método permite a atualização de registros existentes no sistema. Pode ser utilizado para modificar informações de itens como compradores, pedidos, planos, assinaturas, etc. Os parâmetros necessários para a atualização são passados dinamicamente, permitindo flexibilidade e fácil adaptação às mudanças no backend.
```python
response = api_client.{modulo}.update(
uuid='uuid-do-item',
campo1="valor1",
campo2="valor2",
...
)
print(response)
```
### `get`
Este método permite a obtenção de uma lista de registros do sistema. Pode ser utilizado para listar itens como compradores, pedidos, planos, assinaturas, etc. Os parâmetros de consulta são passados dinamicamente, permitindo a filtragem e busca conforme necessário.
```python
response = api_client.{modulo}.get(
filtro1="valor1",
filtro2="valor2",
...
)
print(response)
```
### `getByUuid`
Este método permite a obtenção de informações detalhadas de um registro específico no sistema. Pode ser utilizado para buscar detalhes de itens como compradores, pedidos, planos, assinaturas, etc. O UUID do registro é passado como parâmetro.
```python
response = api_client.{modulo}.getByUuid(
uuid='uuid-do-item'
)
print(response)
```
### `cancel`
Este método permite a exclusão de registros no sistema. Pode ser utilizado para remover itens como compradores, pedidos, planos, assinaturas, etc. O UUID do registro a ser excluído é passado como parâmetro.
```python
response = api_client.{modulo}.delete(
uuid='uuid-do-item'
)
print(response)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "BarteSDK",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "barte pay sdk",
"author": "Engenharia de Plataforma da Barte",
"author_email": "devops@barte.com",
"download_url": "https://files.pythonhosted.org/packages/4e/95/56b77dcd807ba3e6ddf136fba904b15b2757db95e5e75d7c77d6d076175d/BarteSDK-1.0.12.tar.gz",
"platform": null,
"description": "# BarteSDK para Python\n\nBem-vindo ao BarteSDK para Python, a solu\u00e7\u00e3o oficial para integra\u00e7\u00e3o com as APIs de pagamento da Barte, projetada para simplificar e acelerar o desenvolvimento de suas aplica\u00e7\u00f5es . Com nosso SDK, voc\u00ea pode facilmente integrar funcionalidades de pagamento, assinaturas, e gest\u00e3o de compradores em sua aplica\u00e7\u00e3o.\n\n## Recursos do SDK\n\nO BarteSDK fornece m\u00e9todos convenientes para interagir com as seguintes APIs:\n\n- **API de Planos**: Facilita o gerenciamento dos planos cadastrados no seu checkout.\n- **API de Pedidos**: Permite gerenciar os pedidos cadastrados no seu sistema.\n- **API de Compradores**: Auxilia na gest\u00e3o dos compradores cadastrados.\n- **API de Cobran\u00e7as**: Fornece ferramentas para o gerenciamento das cobran\u00e7as.\n- **API de Assinaturas**: Facilita a cria\u00e7\u00e3o e gest\u00e3o de assinaturas.\n\n## Vantagens do BarteSDK\n\nO BarteSDK foi desenvolvido pensando na efici\u00eancia e na otimiza\u00e7\u00e3o do tempo de desenvolvimento, oferecendo uma s\u00e9rie de vantagens que v\u00e3o al\u00e9m da simples integra\u00e7\u00e3o com nossas APIs. Embora seu uso n\u00e3o seja obrigat\u00f3rio, recomendamos fortemente que voc\u00ea o adote para aproveitar os seguintes benef\u00edcios:\n\n- **Mais Efici\u00eancia e Redu\u00e7\u00e3o de Custos**: Implementar nosso SDK significa reduzir custos operacionais e de desenvolvimento. Ele j\u00e1 est\u00e1 pronto para uso e totalmente homologado pela Barte, garantindo que voc\u00ea esteja sempre alinhado com as melhores pr\u00e1ticas e padr\u00f5es do mercado.\n\n- **Instala\u00e7\u00e3o Otimizada**: Facilitamos a instala\u00e7\u00e3o com nossa solu\u00e7\u00e3o plug-and-play, que se integra perfeitamente a sistemas de gest\u00e3o de pacotes como Composer, Gradle, Maven e NPM. Isso agiliza significativamente a integra\u00e7\u00e3o do SDK ao seu projeto, economizando tempo valioso de desenvolvimento.\n\n- **Constru\u00e7\u00e3o de Requisi\u00e7\u00f5es Simplificada**: Simplifique a constru\u00e7\u00e3o de suas requisi\u00e7\u00f5es com nossa interface intuitiva. O SDK foi projetado para minimizar a complexidade, otimizar o desenvolvimento e garantir uma implementa\u00e7\u00e3o eficaz e livre de erros.\n\n- **Seguran\u00e7a de Dados**: A seguran\u00e7a \u00e9 uma prioridade absoluta no BarteSDK. Utilizamos as melhores pr\u00e1ticas e padr\u00f5es de seguran\u00e7a para proteger todas as informa\u00e7\u00f5es transmitidas, garantindo a integridade e confidencialidade dos dados dos seus clientes.\n\nAdotar o BarteSDK n\u00e3o \u00e9 apenas uma quest\u00e3o de conveni\u00eancia; \u00e9 uma decis\u00e3o estrat\u00e9gica que fortalece a seguran\u00e7a, reduz custos e aumenta a efici\u00eancia do desenvolvimento de software na sua organiza\u00e7\u00e3o.\n\n\n## Como Come\u00e7ar\n\nPara come\u00e7ar a usar o BarteSDK, siga os passos abaixo:\n\n1. **INSTALA\u00c7\u00c3O**\n\n\n Instale o SDK via pip:\n\n ```bash\n pip install bartesdk\n\n2. **QUICKSTART**\n\nTodos os requests feitos utilizando o bartesdk devem incluir alguns par\u00e2metros comuns para garantir a autentica\u00e7\u00e3o e a especifica\u00e7\u00e3o do ambiente e vers\u00e3o da API. Esses par\u00e2metros s\u00e3o essenciais para a comunica\u00e7\u00e3o adequada com os servi\u00e7os da Barte.\n\n- `api_key`: Chave de API gerada no Portal do Seller em Configura\u00e7\u00f5es -> Integra\u00e7\u00e3o -> Chaves API. Esta chave \u00e9 utilizada para autenticar as requisi\u00e7\u00f5es e garantir que apenas usu\u00e1rios autorizados possam acessar os recursos da API.\n\n- `env`: Especifica em qual ambiente o request dever\u00e1 ser feito. Os valores poss\u00edveis s\u00e3o: \"prd\" ou \"sandbox\".\n\n- `api_version`: Vers\u00e3o da API que est\u00e1 sendo utilizada. Atualmente, as vers\u00f5es dispon\u00edveis s\u00e3o v1 e v2.\n\n### Exemplo de Requisi\u00e7\u00e3o:\n\n ```python\nfrom bartesdk import BarteSDK\n\n# Defina sua chave de API gerada no Portal do Seller\napi_key = 'your-api-token'\n\n# Crie uma inst\u00e2ncia da classe BarteSDK especificando o ambiente e a vers\u00e3o da API\napi_client = BarteSDK(api_key, env=\"sandbox\", api_version=\"v2\")\n\n# Fa\u00e7a um request para um m\u00f3dulo e m\u00e9todo espec\u00edficos\nresponse = api_client.{modulo}.{metodo}(\n x='y'\n)\n\n# Imprima a resposta do request\nprint(response)\n```\n\n3. **M\u00d3DULOS**\n\n\n### `buyers`\n\nGerencie os perfis dos compradores registrados no seu sistema de maneira eficiente. Este m\u00f3dulo permite criar novos registros, listar os existentes, atualizar informa\u00e7\u00f5es e excluir dados conforme necess\u00e1rio. Facilita a administra\u00e7\u00e3o completa dos perfis, assegurando que as informa\u00e7\u00f5es estejam sempre atualizadas e acess\u00edveis.\n\n### `charges`\n\nGerencie as cobran\u00e7as registradas no seu sistema, permitindo a cria\u00e7\u00e3o, listagem, atualiza\u00e7\u00e3o, estorno e cancelamento de cobran\u00e7as de forma eficiente e segura.\n\n### `plans`\n\nGerencia os planos de pagamento cadastrados no seu sistema de checkout. Com este m\u00f3dulo, voc\u00ea pode criar novos planos, listar todos os planos cadastrados, atualizar detalhes de planos existentes e excluir planos conforme necess\u00e1rio. Ideal para administrar diversos tipos de planos de assinatura ou pagamento recorrente, garantindo flexibilidade e controle total sobre as op\u00e7\u00f5es de pagamento oferecidas aos seus clientes.\n####\n\n### `orders`\n\nO m\u00f3dulo de Orders permite gerenciar pedidos registrados no seu sistema de maneira eficiente e flex\u00edvel. Com ele, \u00e9 poss\u00edvel criar novos pedidos, listar pedidos existentes, atualizar detalhes de pedidos espec\u00edficos e obter informa\u00e7\u00f5es detalhadas sobre pedidos individuais. Ele foi projetado para ser robusto e adapt\u00e1vel, aceitando uma ampla variedade de par\u00e2metros que facilitam a integra\u00e7\u00e3o e a manuten\u00e7\u00e3o do sistema.\n####\n\n### `subscription`\n\nO m\u00f3dulo de Subscriptions permite gerenciar assinaturas no seu sistema de maneira eficiente e flex\u00edvel. Com ele, voc\u00ea pode criar novas assinaturas, listar assinaturas existentes, atualizar detalhes de assinaturas espec\u00edficas, cancelar assinaturas e obter informa\u00e7\u00f5es detalhadas sobre assinaturas individuais. A API \u00e9 projetada para ser robusta e adapt\u00e1vel, aceitando uma ampla variedade de par\u00e2metros que facilitam a integra\u00e7\u00e3o e a manuten\u00e7\u00e3o do sistema.\n####\n\n4. **M\u00c9TODOS**\n\n### `create`\n\nEste m\u00e9todo permite a cria\u00e7\u00e3o de novos registros no sistema. Pode ser utilizado para adicionar novos itens, como compradores, pedidos, planos, assinaturas, entre outros. Os par\u00e2metros necess\u00e1rios para a cria\u00e7\u00e3o s\u00e3o passados dinamicamente, permitindo flexibilidade e f\u00e1cil adapta\u00e7\u00e3o \u00e0s mudan\u00e7as no backend.\n\n ```python\n response = api_client.{modulo}.create(\n campo1=\"valor1\",\n campo2=\"valor2\",\n ...\n)\nprint(response)\n```\n\n### `update`\n\nEste m\u00e9todo permite a atualiza\u00e7\u00e3o de registros existentes no sistema. Pode ser utilizado para modificar informa\u00e7\u00f5es de itens como compradores, pedidos, planos, assinaturas, etc. Os par\u00e2metros necess\u00e1rios para a atualiza\u00e7\u00e3o s\u00e3o passados dinamicamente, permitindo flexibilidade e f\u00e1cil adapta\u00e7\u00e3o \u00e0s mudan\u00e7as no backend.\n\n ```python\n response = api_client.{modulo}.update(\n uuid='uuid-do-item',\n campo1=\"valor1\",\n campo2=\"valor2\",\n ...\n )\n print(response)\n```\n\n### `get`\n\nEste m\u00e9todo permite a obten\u00e7\u00e3o de uma lista de registros do sistema. Pode ser utilizado para listar itens como compradores, pedidos, planos, assinaturas, etc. Os par\u00e2metros de consulta s\u00e3o passados dinamicamente, permitindo a filtragem e busca conforme necess\u00e1rio.\n\n ```python\nresponse = api_client.{modulo}.get(\n filtro1=\"valor1\",\n filtro2=\"valor2\",\n ...\n)\nprint(response)\n```\n\n### `getByUuid`\n\nEste m\u00e9todo permite a obten\u00e7\u00e3o de informa\u00e7\u00f5es detalhadas de um registro espec\u00edfico no sistema. Pode ser utilizado para buscar detalhes de itens como compradores, pedidos, planos, assinaturas, etc. O UUID do registro \u00e9 passado como par\u00e2metro.\n\n ```python\n response = api_client.{modulo}.getByUuid(\n uuid='uuid-do-item'\n )\n print(response)\n ```\n\n### `cancel`\n\nEste m\u00e9todo permite a exclus\u00e3o de registros no sistema. Pode ser utilizado para remover itens como compradores, pedidos, planos, assinaturas, etc. O UUID do registro a ser exclu\u00eddo \u00e9 passado como par\u00e2metro.\n\n ```python\nresponse = api_client.{modulo}.delete(\n uuid='uuid-do-item'\n)\nprint(response)\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "SDK para intera\u00e7\u00e3o com a API da Barte.",
"version": "1.0.12",
"project_urls": null,
"split_keywords": [
"barte",
"pay",
"sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe1ec2fb127a1134af707624379d6d45ad9333da4d85e8e2d593ce22271887c3",
"md5": "008a246a11a05847e24a56ca16b3b627",
"sha256": "e773f6ef0f4eff4104aedd25ef600107d324db681df30649696746cf905344c8"
},
"downloads": -1,
"filename": "BarteSDK-1.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "008a246a11a05847e24a56ca16b3b627",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7364,
"upload_time": "2024-06-07T21:19:43",
"upload_time_iso_8601": "2024-06-07T21:19:43.615731Z",
"url": "https://files.pythonhosted.org/packages/fe/1e/c2fb127a1134af707624379d6d45ad9333da4d85e8e2d593ce22271887c3/BarteSDK-1.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4e9556b77dcd807ba3e6ddf136fba904b15b2757db95e5e75d7c77d6d076175d",
"md5": "e2458e52842c9e018a47bd6340fd3f70",
"sha256": "e42763bd0f3d9835b1bc3d14bf4fdb7d05ab628ef90b3418e69e9cf592eb9390"
},
"downloads": -1,
"filename": "BarteSDK-1.0.12.tar.gz",
"has_sig": false,
"md5_digest": "e2458e52842c9e018a47bd6340fd3f70",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5447,
"upload_time": "2024-06-07T21:19:45",
"upload_time_iso_8601": "2024-06-07T21:19:45.036784Z",
"url": "https://files.pythonhosted.org/packages/4e/95/56b77dcd807ba3e6ddf136fba904b15b2757db95e5e75d7c77d6d076175d/BarteSDK-1.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-07 21:19:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bartesdk"
}
JSON