Skip to main content

Integração com API da Vindi (Python 3.5+)

Project description

TravisCI Build Status Coverage Status Requirements Status Scrutinizer Code Quality Code Climate


Integração com API da Vindi (Python 3.5+).

Como instalar

pip install vindi

Tutorial

>>> # import inicial
>>> from vindi.api import get_api_instance
>>> # criando uma nova instância da api
>>> api = get_api_instance(token='seu-token-da-vindi')
>>> # listando todos os resources disponíveis
>>> api.get_resource_list()
['customers', 'plans', 'products', 'payment_methods', 'discounts', 'subscriptions', 'product_items', 'periods', 'bills', 'bill_items', 'charges', 'transactions', 'payment_profiles', 'usages', 'invoices', 'movements', 'messages', 'import_batches', 'merchant', 'issues']
>>> # listando todas as ações disponíveis para o resource customers
>>> api.customers.actions
{'list': {'method': 'GET', 'url': 'customers'}, 'create': {'method': 'POST', 'url': 'customers'}, 'retrieve': {'method': 'GET', 'url': 'customers/{}'}, 'update': {'method': 'PUT', 'url': 'customers/{}'}, 'destroy': {'method': 'DELETE', 'url': 'customers/{}'}}
>>> # executando ação list com todos os parâmetros possíveis
>>> response = api.customers.list(body=None, params={}, headers={})
>>> # trabalhando com uma instância response
>>> response.url
'https://app.vindi.com.br/api/v1/customers'
>>> response.method
'GET'
>>> response.headers
{'Cache-Control': 'max-age=0, private, must-revalidate', 'Content-Type': 'application/json; charset=UTF-8', 'Date': 'Fri, 21 Apr 2017 15:30:11 GMT', 'ETag': 'W/"0cbcb8ab8eb167a7525bdc61c7b89ba3"', 'Per-Page': '25', 'Rate-Limit-Limit': '120', 'Rate-Limit-Remaining': '119', 'Rate-Limit-Reset': '1492788671', 'Server': 'nginx', 'Total': '2', 'Vindi-Merchant-Id': '5963', 'X-Request-Id': 'd155bf74-df8e-4803-8281-8f1fe0373814', 'X-Runtime': '0.034142', 'Content-Length': '773', 'Connection': 'keep-alive'}
>>> response.body
{'customers': [{'id': 2481112, 'name': 'Jane Doe', 'email': 'jane@doe.com', 'registry_code': None, 'code': None, 'notes': None, 'status': 'archived', 'created_at': '2017-04-19T13:08:51.000-03:00', 'updated_at': '2017-04-19T13:25:57.000-03:00', 'metadata': {}, 'address': {'street': None, 'number': None, 'additional_details': None, 'zipcode': None, 'neighborhood': None, 'city': None, 'state': None, 'country': None}, 'phones': []}, {'id': 2481258, 'name': 'John Doe', 'email': 'john@doe.com', 'registry_code': None, 'code': None, 'notes': None, 'status': 'inactive', 'created_at': '2017-04-19T13:27:35.000-03:00', 'updated_at': '2017-04-19T13:27:35.000-03:00', 'metadata': {}, 'address': {'street': None, 'number': None, 'additional_details': None, 'zipcode': None, 'neighborhood': None, 'city': None, 'state': None, 'country': None}, 'phones': []}]}
>>> response.status_code
200
>>> # fim \o/

Verifique a documentação da API Vindi.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vindi-0.1.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

vindi-0.1.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file vindi-0.1.0.tar.gz.

File metadata

  • Download URL: vindi-0.1.0.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for vindi-0.1.0.tar.gz
Algorithm Hash digest
SHA256 667cf9c47e151c9dac6429c2230b083dc78c70a27942ece247f3b2216549bdbf
MD5 fa4ba737645c6295a5f5c71c90df0d0e
BLAKE2b-256 92c50d81efbfd0841745b52c06c4fdbb15edfaad4169ed67f17820d2f06302e6

See more details on using hashes here.

File details

Details for the file vindi-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for vindi-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4b63107d085825db62775f509df07087ec89fe4097adc84900688e8693f15d7a
MD5 0d029c7aa34fff152aa64fe1ea371ef7
BLAKE2b-256 9d4a077270999984f474c4951edb3e28497d02806c422f43eca0065c0a96c2b5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page