forked from greguly/cielo-woocommerce
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
346 lines (207 loc) · 16.2 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
=== Cielo WooCommerce ===
Contributors: Gabriel Reguly, claudiosanches
Donate link: http://claudiosmweb.com/doacoes/
Tags: WooCommerce, Payment Gateway, Cielo
Requires at least: 3.5
Tested up to: 4.0
Stable tag: 3.1.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Adds Brazilian payment gateway Cielo to WooCommerce
== Description ==
### Adds Brazilian payment gateway Cielo to WooCommerce. ###
The Cielo WooCommerce plugin enables integration with WooCommerce and the Cielo Payment Gateway (for Brazilian Merchants).
Please notice that WooCommerce must be installed and active.
= Contribute =
You can contribute to the source code in our [GitHub](https://github.com/greguly/cielo-woocommerce) page.
### Descrição em Português: ###
Utilize a Cielo em sua loja WooCommerce e permita os seus clientes pagarem com cartão de crédito ou débido.
A [Cielo](http://www.cielo.com.br/) é uma empresa líder em soluções de pagamentos eletrônicos na América Latina. Responsável pelo credenciamento de estabelecimentos comerciais, e pela captura, transmissão, processamento e liquidação financeira das transações realizadas com cartões de crédito e débito, capturando transações das maiores bandeiras de cartões do mundo.
Estão disponíveis as seguintes bandeiras:
* Visa (crédito e débido)
* MasterCard (crédito e débido)
* Diners Club
* Discover
* Elo
* American Express
* JCB
* Aura
Com este plugin é possível escolher entre os modelos de *BuyPage*:
* Cielo
* Loja (ainda não implementado, será possível em breve)
= Desenvolvimento =
O plugin **Cielo WooCommerce** foi desenvolvido sem nenhum incentivo da Cielo. Isto quer dizer que nenhum dos desenvolvedores deste plugin possuem vínculos com a Cielo e contamos com a sua ajuda para melhorar o código e o funcionamento deste plugin.
Toda a integração foi desenvolvida a partir da última versão do [kit de integração da Cielo](http://www.cielo.com.br/portal/cielo/solucoes-de-tecnologia/e-commerce.html).
= Compatibilidade =
Compatível com as versões 2.0.x e 2.1.x do [WooCommerce](http://wordpress.org/plugins/woocommerce/).
= Instalação =
Confira o nosso guia de instalação e configuração da Cielo na aba [Installation](http://wordpress.org/plugins/cielo-woocommerce/installation/).
= Dúvidas? =
Você pode esclarecer suas dúvidas usando:
* A nossa sessão de [FAQ](http://wordpress.org/plugins/cielo-woocommerce/faq/).
* O fórum de suporte do [WordPress](http://wordpress.org/support/plugin/cielo-woocommerce) (apenas em inglês).
* O fórum de suporte do [WordPress Brasil](http://br.forums.wordpress.org/forum/plugins-e-codigos) utilizando as tags "cielo" e "woocommerce".
* O nosso fórum de suporte no [GitHub](https://github.com/greguly/cielo-woocommerce/issues).
= Coloborar =
Você pode contribuir com código-fonte em nossa página no [GitHub](https://github.com/greguly/cielo-woocommerce).
= Agradecimentos =
* [Anilton Veiga](https://www.behance.net/aniltonveiga) - Criação do design/ícones do formulário de pagamento.
== Installation ==
* Upload plugin files to your plugins folder, or install using WordPress built-in Add New Plugin installer;
* Activate the plugin;
* Navigate to WooCommerce -> Settings -> Payment Gateways, choose Cielo and fill the plugin options.
### Instalação e configuração em Português: ###
= Instalação do plugin: =
* Envie os arquivos do plugin para a pasta wp-content/plugins, ou instale usando o instalador de plugins do WordPress.
* Ative o plugin.
* Para mais detalhes sobre a instalação de plugins no WordPress leia o tutorial [WordPress - Gerenciando Plugins](http://codex.wordpress.org/pt-br:Gerenciando_Plugins#Instalando_Plugins).
= Requerimentos: =
* Ter um site pronto com o WordPress e WooCommerce instalados.
* Utilizar um certificado SSL (é recomendado um de 2048 bits).
* Ler o material "[Boas Práticas de Segurança no e-Commerce](http://www.cielo.com.br/documents/b771c7655be54bc983aba229162f0faa.pdf)" da Cielo.
* Ter cadastro no [Cielo e-Commerce](http://www.cielo.com.br/portal/cielo/solucoes-de-tecnologia/e-commerce.html), faça o seu cadastro utilizando:
* [Cadastro de clientes do Banco do Brasil, Bradesco ou HSBC](http://www.cielo.com.br/sitecielo/afiliacao/credenciamentoafiliacaonaologado.html)
* [Cadastro de clientes dos demais bancos](http://www.cielo.com.br/sitecielo/e-commerce/credenciamento-ecommerce.html)
= Configurações do plugin: =
É possível acessar a tela de configurações do plugin na página de administração do WordPress em `WooCommerce -> Configurações -> Finalizar Compra -> Cielo`.
O plugin funciona com os ambientes de **Teste** e **Produção**, onde você deve utilizar o ambiente de **Teste** para testar a integração antes de fazer a homologação. Uma vez que estiver homologado, você poderá ter utilizar o ambiente de **Produção** onde é possível entrar com o **número** e a **chave** de afiliação do estabelecimento com a Cielo.
#### Notas sobre o ambiente de testes ####
No ambiente de **Testes** é possível utilizar alguns cartões de teste disponíveis no [kit de integração da Cielo](http://www.cielo.com.br/portal/cielo/solucoes-de-tecnologia/e-commerce.html), basta fazer o download do kit e ler o arquivo "Cielo e-Commerce - Manual do Desenvolvedor X.X.X.X.pdf" que esta dentro da pasta "Materiais Técnicos".
Outra coisa importante é saber que o ambiente de **Testes** tem alguns comportamentos peculiares que você deve conhecer para poder utilizá-lo com eficiência:
* Para simular pagamentos aprovados o valor total do pedido não pode ter nenhum centavo, exemplo: `R$ 100,00`.
* É possível simular pagamentos recusados fazendo pedidos com o valor total contendo centavos, exemplo: `R$ 100,99`.
* Os cartões do kit de integração que estão marcados com a opção "Autenticação" poderão redirecionar para uma página em branco com um XML e um botão, logo após inserir os dados dentro da página da Cielo, isto é normal e serve para "simular" a autenticação dentro do banco do cliente, basta clicar no botão e você será redirecionado novamente para a sua loja (não se preocupe, o cliente não irá ver esta tela no ambiente de produção e sim o site de seu banco).
* Ao tentar simular uma compra, observe que o juros as vezes pode adicionar centavos no total e isso vai simular uma transação recusada (parece besta, mas muita gente quer simular pagamentos aprovados e acaba forçando todos para serem recusados por causa disso).
== Frequently Asked Questions ==
= What is the plugin license? =
* This plugin is released under a GPL license.
= What is needed to use this plugin? =
* WooCommerce version 2.0.x or latter installed and active.
* Follow our [installation guide](http://wordpress.org/plugins/cielo-woocommerce/installation/).
### FAQ em Português: ###
= Qual é a licença do plugin? =
Este plugin esta licenciado como GPL.
= O que eu preciso para utilizar este plugin? =
* WooCommerce versão 2.0.x ou superior instalado e ativado.
* Seguir o nosso [guia de instalação](http://wordpress.org/plugins/cielo-woocommerce/installation/).
= São aceitas quais moedas? =
No momento apenas Real (BRL).
= Quais são as bandeiras disponíveis? =
* Visa (crédito e débido)
* MasterCard (crédito e débido)
* Diners Club
* Discover
* Elo
* American Express
* JCB
* Aura
= Quais são os modelos de BuyPage disponíveis? =
* Cielo
* Loja (ainda não implementado, será possível em breve)
= Como funciona a BuyPage Cielo? =
Na BuyPage Cielo a digitação dos dados do cartão será no ambiente da Cielo. Geralmente é aconselhada a clientes que não queiram lidar com questões de segurança e desejam utilizar a infraestrutura da Cielo.
= Como funciona a BuyPage Loja? =
Na BuyPage Loja a digitação dos dados do cartão será no ambiente da Loja. Ou seja, a própria Loja se encarrega do desenvolvimento de uma página segura na Internet (HTTPS), respeitando políticas de segurança, para capturar os dados do cartão do portador.
Este modelo de BuyPage não esta disponível ainda no plugin, iremos implementar em breve e contamos com a sua ajuda, tanto para a melhoria do código e implementação desta feature como também para doações (desta forma você ajuda os desenvolvedores deste plugin a ter mais tempo livre para implementar esta funcionalidade).
= É possível usar o pagamento por celular? =
No momento ainda não é possível, entretanto pretendemos integrar no futuro.
= É possível fazer pagamentos recorrentes/assinaturas? =
Não é possível no momento, mas será entregado no futuro.
= O pedido foi pago e ficou com o status de "processando" e não como "concluído", isto esta certo ? =
Sim, esta certo e significa que o plugin esta trabalhando como deveria.
Todo gateway de pagamentos no WooCommerce deve mudar o status do pedido para "processando" no momento que é confirmado o pagamento e nunca deve ser alterado sozinho para "concluído", pois o pedido deve ir apenas para o status "concluído" após ele ter sido entregue.
Para produtos baixáveis a configuração padrão do WooCommerce é permitir o acesso apenas quando o pedido tem o status "concluído", entretanto nas configurações do WooCommerce na aba *Produtos* é possível ativar a opção **"Conceder acesso para download do produto após o pagamento"** e assim liberar o download quando o status do pedido esta como "processando".
= É possível cancelar o pagamento/devolver o dinheiro do cliente pelo plugin? =
Sim é possível fazer reembolsos do valor total ou parcial, entretanto apenas para transações feitas em menos de 90 dias,
**Reembolso total**
Basta mudar o status do pedido para "reembolsado", desta forma é enviado um sinal para a Cielo dizendo que a transação deve ser cancelada e o valor reembolsado.
* Nota: Isto irá funcionar apenas para pagamentos feitos depois de instalada a versão 3.0.0 deste plugin.
**Reembolso parcial**
A partir do WooCommerce 2.2 foi implementada uma API e uma interface para fazer reembolsos parciais e este plugin a partir da versão 3.1.0 esta totalmente integrado com esta nova API.
Desta forma basta fazer o reembolso na tela do pedido, assim será enviado um sinal para a Cielo dizendo qual o valor deve ser reembolsado.
* Nota: Para reembolsos parciais você deve utilizar o WooCommerce 2.2 ou superior, além de que os pedidos devem ter sido feitos nesta versão e também com o Cielo WooCommerce na versão 3.1.0 ou superior.
= Aconteceu um erro, o que eu faço? =
Sempre que ocorrer um erro você deve ativar a opção de log do plugin e tentar simular o erro novamente, desta forma o erro será gravado no arquivo de log e você poderá saber o que aconteceu.
Não é um problema caso você não consiga entender o arquivo de log, pois você pode salvar o conteúdo dele utilizando o [pastebin.com](http://pastebin.com) ou o [gist.github.com](http://gist.github.com) solicitar ajuda usando:
* O fórum de suporte do [WordPress](http://wordpress.org/support/plugin/cielo-woocommerce) (apenas em inglês).
* O fórum de suporte do [WordPress Brasil](http://br.forums.wordpress.org/forum/plugins-e-codigos) utilizando as tags "cielo" e "woocommerce".
* O nosso fórum de suporte no [GitHub](https://github.com/greguly/cielo-woocommerce/issues).
= O que fazer quando tentar finalizar a compra aparece a mensagem "Cielo: Um erro aconteceu ao processar o seu pagamento, por favor, tente novamente ou entre em contato para conseguir assistência" ? =
Esta mensagem geralmente irá aparecer quando o seu servidor tiver problemas para fazer a conexão com a Cielo. Mas é possível saber com certeza o que aconteceu de errado utilizando a opção de log do plugin como descrito na sessão acima.
== For Developers ==
= Criando um template personalizado para o formulário do checkout =
É possível alterar formulário e adicionar um customizado utilizando o filtro `wc_cielo_form_path`.
Exemplo de uso do filtro em um tema:
function custom_wc_cielo_form_path( $path ) {
return get_template_directory() . '/cielo-html-form.php';
}
add_filter( 'wc_cielo_form_path', 'custom_wc_cielo_form_path' );
Depois basta criar o arquivo `cielo-html-form.php` dentro do seu tema e escrever o HTML dele como você julgar melhor (utilize os modelos prontos no plugin dentro de `includes/views` para ter uma ideia de como deve ser os elementos e as variáveis que você pode utilizar).
Ao criar um formulário customizado pode ser boa ideia remover os scripts adicionados pelo plugin e você pode fazer da seguinte forma:
function remove_wc_cielo_scripts() {
wp_dequeue_style( 'wc-cielo-checkout-icons' );
wp_dequeue_script( 'wc-cielo-checkout-icons' );
}
add_action( 'wp_enqueue_scripts', 'remove_wc_cielo_scripts', 1000 );
== Screenshots ==
1. Configurações do plugin.
2. Checkout com o formulário padrão.
2. Checkout com o formulário utilizando ícones dos cartões.
== Changelog ==
= 3.1.1 - 07/09/2014 =
* Melhorada a integração com o `_transaction_id` para o WooCommerce 2.2.
= 3.1.0 - 07/09/2014 =
* Adicionado suporte para reembolsos parciais do WooCommerce 2.2.
* Melhorada a compatibilidade com o WordPress 4.0.
= 3.0.3 - 25/06/2014 =
* Adicionada opção para selecionar os métodos de débito disponíveis.
= 3.0.2 - 22/06/2014 =
* Melhorada a exibição das notas do pedido com as informações sobre o pagamento.
* Corrigido o script que atualiza as opções do plugin ao utilizar uma versão mais nova.
= 3.0.1 - 22/06/2014 =
* Permitido valores inferiores a R$ 5,00 para pagamento à vista em cartão de crédito.
* Quando cancelado o pagamento na tela da Cielo o cliente é redirecionado para o caralogo do WooCommerce.
= 3.0.0 - 22/06/2014 =
* Refatorado todo o código do plugin.
* Adicionado completo suporte para as versões 2.0.x e 2.1.x do WooCommerce
* Atualizada a versão da API da Cielo para 1.3.0.
* Adicionada ação de cancelar a transação (devolver o dinheiro) ao marcar o pedido como "reembolsado".
* Adicionada novas formas de exibir o formulário com os cartões de crédito e parcelas disponíveis.
* Removida a opção de captura (não tinha utilidade e a melhor forma de trabalhar é capturar automaticamente sempre).
* Adicionado suporte para os cartões JBC e Aura.
* Adicionado opção de pagamento por débito para o MasterCard.
* Adicionada uma mensagem informando o cartão, forma de pagamento (crédito ou débito) e quantidade de parcelas nas notas do pedido ao concluir o pagamento.
* Adicionado filtro `wc_cielo_form_path`, que torna possível customizar o formulário de seleção do cartão e de parcelas.
= 2.0.10 - 17/06/2014 =
* Corrigido a finalização e a URL de retorno para versões 2.0.x do WooCommerce.
= 2.0.9 - 12/06/2014 =
* Correção dos valores padrões das opções.
= 2.0.8 - 12/06/2014 =
* Correção do retorno do pagamento para as versões 2.1.x do WooCommerce.
= 2.0.7 - 11/06/2014 =
* Suporte inicial para as versões 2.1.x do WooCommerce.
= 2.0.5 =
* Adicionadas mensagens de erro para quando as bandeiras de cartão não foram selecionadas.
* Removido o template customizado review-order.php
= 2.0.4 =
* Adicionada opção de reduzir o estoque quando o pagamento é completado com sucesso.
= 2.0.3 =
* Corrigida falha com a página de retorno da Cielo.
= 2.0.2 =
* Fixed a bug with as_is()/PHP < 5.3 where it hang at payment page.
* Added a direct settings link on plugins page list.
= 2.0.1 =
* Fixed a bug, thanks for Claudio Sanches who reported it.
= 2.0 =
* Updated to WooCommerce 2.0
= 1.0 =
* Initial plugin release.
== Upgrade Notice ==
= 3.1.1 =
* Adicionado suporte para reembolsos parciais do WooCommerce 2.2.
* Melhorada a compatibilidade com o WordPress 4.0.
* Melhorada a integração com o `_transaction_id` para o WooCommerce 2.2.
== License ==
Cielo WooCommerce is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Cielo WooCommerce is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Cielo WooCommerce. If not, see <http://www.gnu.org/licenses/>.