Documentação do python-cielo-webservice¶

Conteúdo:

Tutorial¶

O python-cielo-webservice é uma biblioteca para trabalhar com a versão Webservice 1.5 da Cielo.

Funciona com as versões 2.7/3.3/3.4/3.5 do Python.

Instalação¶

Instale usando o pip:

pip install python-cielo-webservice

Primeiros passos¶

Vamos começar abrindo um shell simples do Python:

python

Fazendo os imports necessários:

>>> from cielo_webservice.request import CieloRequest
>>> from cielo_webservice.models import Comercial, Cartao, Pedido, Pagamento, Transacao
>>> from datetime import datetime

Adicionando dados do estabelecimento comercial:

>>> comercial = Comercial(numero=1006993069, chave='25fbb99741c739dd84d7b06ec78c9bac718838630f30b112d033ce2e621b34f3')
>>> comercial
<Comercial(numero=1006993069, chave=25fbb99741c739dd84d7b06ec78c9bac718838630f30b112d033ce2e621b34f3)>

Adicionando dados do cartão:

>>> cartao = Cartao(numero=4012001037141112, validade=201805, indicador=1, codigo_seguranca=123, nome_portador='Fulano Silva')
>>> cartao
<Cartao(numero=4012001037141112, validade=201805, indicador=1, codigo_seguranca=123, nome_portador=Fulano Silva, token=None)>

Adicionando dados do pedido:

>>> pedido = Pedido(numero='1234', valor=10000, moeda=986, data_hora=datetime.now().isoformat())
>>> pedido
<Pedido(numero=1234, valor=10000, moeda=986, data_hora=2016-03-05T12:43:53.062540, descricao=None, idioma=PT, taxa_embarque=None, soft_descriptor=None)>

Adicionando dados do pagamento:

>>> pagamento = Pagamento(bandeira='visa', produto='1', parcelas=1)
>>> pagamento
<Pagamento(bandeira=visa, produto=1, parcelas=1)>

Criando a transação:

>>> transacao = Transacao(comercial=comercial, cartao=cartao, pedido=pedido, pagamento=pagamento, autorizar=3, capturar=True)
>>> transacao
<Transacao(comercial=<Comercial(numero=1006993069, chave=25fbb99741c739dd84d7b06ec78c9bac718838630f30b112d033ce2e621b34f3)>, cartao=<Cartao(numero=4012001037141112, validade=201805, indicador=1, codigo_seguranca=123, nome_portador=Fulano Silva, token=None)>, pedido=<Pedido(numero=1234, valor=10000, moeda=986, data_hora=2016-03-05T12:43:53.062540, descricao=None, idioma=PT, taxa_embarque=None, soft_descriptor=None)>, pagamento=<Pagamento(bandeira=visa, produto=1, parcelas=1)>, url_retorno=None, autorizar=3, capturar=True, campo_livre=None, bin=None, gerar_token=None, avs=None, autenticacao=None, autorizacao=None, captura=None, token=None, cancelamento=None, tid=None, pan=None, status=None, url_autenticacao=None)>

Iniciando o objeto CieloRequest:

>>> request = CieloRequest(sandbox=True)

Autorizando a transação:

>>> transacao_autorizada = request.autorizar(transacao=transacao)
>>> transacao_autorizada
<Transacao(comercial=None, cartao=None, pedido=<Pedido(numero=1234, valor=10000, moeda=986, data_hora=2016-03-05T09:45:06.148-03:00, descricao=None, idioma=PT, taxa_embarque=0, soft_descriptor=None)>, pagamento=<Pagamento(bandeira=visa, produto=1, parcelas=1)>, url_retorno=None, autorizar=None, capturar=None, campo_livre=None, bin=None, gerar_token=None, avs=None, autenticacao=<Autenticacao(codigo=6, mensagem=Transacao sem autenticacao, data_hora=2016-03-05T09:45:06.170-03:00, valor=10000, eci=7)>, autorizacao=<Autorizacao(codigo=6, mensagem=Transacao autorizada, data_hora=2016-03-05T09:45:06.173-03:00, valor=10000, lr=0, arp=123456, nsu=37056)>, captura=<Captura(codigo=6, mensagem=Transacao capturada com sucesso, data_hora=2016-03-05T09:45:06.190-03:00, valor=10000, taxa_embarque=None)>, token=None, cancelamento=None, tid=10069930690005C1E40A, pan=IqVz7P9zaIgTYdU41HaW/OB/d7Idwttqwb2vaTt8MT0=, status=6, url_autenticacao=None)>
>>> transacao_autorizada.tid
u'10069930690005C1E40A'
>>> transacao_autorizada.pan
u'IqVz7P9zaIgTYdU41HaW/OB/d7Idwttqwb2vaTt8MT0='
>>> print(transacao_autorizada.autenticacao.codigo)
6
>>> print(transacao_autorizada.autenticacao.data_hora)
2016-03-05T09:45:06.170-03:00
>>> print(transacao_autorizada.autenticacao.eci)
7
>>> print(transacao_autorizada.autenticacao.mensagem)
Transacao sem autenticacao
>>> print(transacao_autorizada.autenticacao.valor)
10000
>>> print(transacao_autorizada.autorizacao.codigo)
6
>>> print(transacao_autorizada.autorizacao.mensagem)
Transação autorizada
>>> print(transacao_autorizada.autorizacao.data_hora)
2016-03-05T09:45:06.173-03:00
>>> print(transacao_autorizada.autorizacao.valor)
10000
>>> print(transacao_autorizada.autorizacao.lr)
0
>>> print(transacao_autorizada.autorizacao.arp)
123456
>>> print(transacao_autorizada.autorizacao.nsu)
37056

API¶

Documentação detalha da API.

Models¶

Comercial¶

class cielo_webservice.models.Comercial(numero=None, chave=None)¶: Modelo para os dados comerciais da loja.

Cartao¶

class cielo_webservice.models.Cartao(numero=None, validade=None, indicador=None, codigo_seguranca=None, nome_portador=None, token=None)¶: Modelo para os dados do cartão.

Pedido¶

class cielo_webservice.models.Pedido(numero=None, valor=None, moeda=986, data_hora=None, descricao=None, idioma=u'PT', taxa_embarque=None, soft_descriptor=None)¶: Modelo para os dados do pedido.

Pagamento¶

class cielo_webservice.models.Pagamento(bandeira=None, produto=None, parcelas=None)¶: Modelo para os dados do pagamento.

Autenticacao¶

class cielo_webservice.models.Autenticacao(codigo=None, mensagem=None, data_hora=None, valor=None, eci=None)¶: Modelo para os dados da autenticação.

Autorizacao¶

class cielo_webservice.models.Autorizacao(codigo=None, mensagem=None, data_hora=None, valor=None, lr=None, arp=None, nsu=None)¶: Modelo para os dados da autorização.

Token¶

class cielo_webservice.models.Token(codigo=None, status=None, numero=None)¶: Modelo para os dados do token.

Avs¶

class cielo_webservice.models.Avs(endereco=None, complemento=None, numero=None, bairro=None, cep=None)¶: Modelo para os dados do avs (ADDRESS VERIFICATION SERVICE).

Captura¶

class cielo_webservice.models.Captura(codigo=None, mensagem=None, data_hora=None, valor=None, taxa_embarque=None)¶: Modelo para os dados da captura.

Cancelamento¶

class cielo_webservice.models.Cancelamento(codigo=None, mensagem=None, data_hora=None, valor=None)¶: Modelo para os dados de cancelamento.

Erro¶

class cielo_webservice.models.Erro(codigo=None, mensagem=None)¶: Modelo para os dados de erro do sistema.

Transacao¶

class cielo_webservice.models.Transacao(comercial=None, cartao=None, pedido=None, pagamento=None, url_retorno=None, autorizar=None, capturar=None, campo_livre=None, bin=None, gerar_token=None, avs=None, autenticacao=None, autorizacao=None, captura=None, token=None, cancelamento=None, tid=None, pan=None, status=None, url_autenticacao=None)¶: Modelo para os dados de uma transação.

Request¶

CieloRequest¶

class cielo_webservice.request.CieloRequest(sandbox=False)¶

Objeto que vai realizar a comunicação com a api da Cielo.

autorizar(transacao)¶: Realiza uma autorização.

cancelar(tid=None, comercial=None, valor=None)¶: Cancela uma transação.

capturar(tid=None, comercial=None, valor=None, taxa_embarque=None)¶: Realiza o processo de captura de uma transação.

consultar(tid=None, comercial=None)¶: Retorna os dados de uma transação.

gerar_token(comercial=None, cartao=None)¶: Gera o token de um cartão de crédito.

Autor¶

Allisson Azevedo

Principais características¶

Python: 2.7, 3.3, 3.4, 3.5.
Processamento de requisições http/https usando a biblioteca requests.
Excelente cobertura de testes (> 80%).
Documentação com exemplos práticos.

Links¶

Referências¶

Cielo: Integração Webservice 1.5