This repository has been archived by the owner on Jan 16, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
readme.txt
279 lines (195 loc) · 10.1 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
=== Cobre Grátis WooCommerce ===
Contributors: claudiosanches
Tags: checkout, billet, boleto, cobregratis
Requires at least: 3.5
Tested up to: 4.0
Stable tag: 1.0.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Start getting money by bank billet in your checking account using Cobre Grátis
== Description ==
### Description (en): ###
Start getting money by bank billet in your checking account using **[Cobre Grátis](http://cobregratis.com.br/)**.
### Descrição (pt_BR): ###
Comece a receber dinheiro por boleto bancário direto na sua conta corrente usando o **[Cobre Grátis](http://cobregratis.com.br/)**. Sem limites e sem taxa por boleto.
= Como Funciona o Boleto Bancário =
[youtube http://www.youtube.com/watch?v=XhCMJ6CpD4M]
O Boleto Bancário é uma forma de pagamento exclusiva do Brasil. Qualquer pessoa física ou jurídica pode cobrar através de boletos bancários. Basta ter uma conta bancária e contratar uma carteira de cobrança junto ao banco. Aprenda mais como funciona, o que é Cedente, Sacado e o que você precisa para começar a cobrar seus clientes por Boleto Bancário.
= Integração =
A integração é completa para vender por boleto e ainda conta com sistema de retorno que avisa quando o boleto é pago, atualizando o status do seu pedido para *processando*.
É possível integrar com os seguintes bancos:
* Banco do Brasil
* Banespa
* Banrisul
* Santander
* Sicredi
* Real
* Itaú
* Bradesco
* HSBC
* Caixa Econômica Federal
* Nossa Caixa
* BCN
* Sudameris
* FINASA
* Unibanco
* Safra
* Citibank
* Bancoob/Sicoob
= Instalação =
Instalar é bem simples, basta seguir o nosso [guia de instalação](http://wordpress.org/extend/plugins/cobregratis-woocommerce/installation/).
= Compatibilidade =
Compatível com as versões 2.0.x e 2.1.x do WooCommerce.
= Dúvidas? =
Você pode esclarecer suas dúvidas usando:
* A nossa sessão de [FAQ](http://wordpress.org/extend/plugins/cobregratis-woocommerce/faq/).
* Criando um tópico no [fórum do GitHub](https://github.com/Cobre Grátis/cobregratis-woocommerce/issues).
* Criando um tópico no [fórum de ajuda do WordPress](http://wordpress.org/support/plugin/cobregratis-woocommerce) (apenas em inglês).
= Coloborar =
Você pode contribuir com código-fonte em nossa página no [GitHub](https://github.com/Cobre Grátis/cobregratis-woocommerce).
== Installation ==
= Instalação do plugin =
* Faça upload dos arquivos do plugin para a sua pasta de plugins ou faça a instalação usando o instalador do WordPress em `Plugins > Adicionar Novo`;
* Ative o plugin.
= Configuração do Cobre Grátis =
1. Crie uma conta e contrate um Plano Pago no [Cobre Grátis](http://cobregratis.com.br/planos/);
2. Com a conta é possível gerar um Token em [Cobre Grátis - Minhas informações](https://app.cobregratis.com.br/myinfo);
3. E finalmente crie uma notificação em [Cobre Grátis - Notificações](https://app.cobregratis.com.br/web_hooks/new);
4. Na notificação criada:;
5. Escolha o evento 'Pago';
6. Escolha a situação 'Ativo';
7. Crie um **Código de Segurança**;
8. E configure a **URL para notificação** como por exemplo `http://seusite.com.br/?wc-api=WC_Cobregratis_Gateway`;
9. Pronto, conta configurada.
= Configuração do plugin =
1. Vá até `WooCommerce > Configurações > Finalizar compra > Cobre Grátis`;
2. Habilite o **Cobre Grátis** e preencha como preferir as opções de *Título* de *Descrição*;
3. Digite o token gerado na sua conta do **Cobre Grátis**;
4. Por final preencha também a opção *Código de segurança da notificação*;
5. Salve as configurações;
6. Vá até `WooCommerce > Configurações > Produtos > Inventário`;
7. Deixe em branco a opção **Manter estoque (minutos)** (isso evita problemas com contas canceladas antes do cliente pagar o boleto).
8. Salve novamente as configurações;
9. Tudo pronto para receber pagamentos via boleto bancário usando o **Cobre Grátis**.
== Frequently Asked Questions ==
= O que eu preciso para utilizar este plugin? =
* Ter instalado o WooCommerce 2.0.x ou superior.
* Com a conta é possível gerar um Token em [Cobre Grátis - Minhas informações](https://app.cobregratis.com.br/myinfo);
* E finalmente crie uma notificação em [Cobre Grátis - Notificações](https://app.cobregratis.com.br/web_hooks/new);
* Na notificação criada:;
* Escolha o evento 'Pago';
* Escolha a situação 'Ativo';
* Crie um **Código de Segurança**;
* E configure a **URL para notificação** como por exemplo `http://seusite.com.br/?wc-api=WC_Cobregratis_Gateway`;
* Pronto, conta configurada.
= O que é o Cobre Grátis? =
O Cobre Grátis é um sistema que funciona na web, feito para que qualquer pessoa possa gerar boletos bancários e gerenciar suas cobranças. Com o Cobre Grátis é possível cadastrar os dados da cobrança que ele gera o boleto bancário para ser enviado para o cliente pagar. Os bancos possuem seus próprios sistemas para isso, mas no Cobre Grátis é possível emitir boletos para diversos bancos e gerenciar todas as cobranças em um só lugar. Além de possuir diversos recursos que outros sistemas não oferecem.
= Quais são os pré-requisitos para usar o Cobre Grátis? =
Para usar o Cobre Grátis é necessário:
1. Ter uma conta corrente em banco;
2. Possuir um contrato de cobrança (chamada de carteira de cobrança);
3. Ter em mãos os dados da conta corrente e os dados da carteira de cobrança;
4. Possuir um computador com acesso à internet;
= Quais os bancos e carteiras suportadas? =
* **Banco do Brasil** - 18-17, 18-027, 17-019, 18-019 (Convênio com 7 dígitos), 18-019 (Convênio com 6 dígitos), 18-019 (Convênio com 8 dígitos)
* **Banespa** - 008
* **Banrisul** - Cob. Direta
* **Santander** - 102
* **Sicredi** - A (Simples)
* **Real** - 57
* **Itaú** - 179, 175, 109, 174, 176, 178, 157
* **Bradesco** - 06, 09, 25, 03
* **HSBC** - CNR, CNR Fácil
* **Caixa Econômica Federal** - SIGCB: 24 ou 02, SINCO, SR (80), SR (82), CR (90), SR5
* **Nossa Caixa** - CIDENT
* **BCN** - 1
* **Sudameris** - Cobrança Simples
* **FINASA** - 27
* **Unibanco** - Cob Especial
* **Safra** - 4
* **Citibank** - 3 - Cobrança Comum, 4 - Cobrança de Seguro
* **Bancoob/Sicoob** - 01, 02
= Mais dúvidas de como funciona o Cobre Grátis? =
Acesse a [FAQ do Cobre Grátis](http://suporte.cobregratis.com.br/hc/pt-br).
== For Developers ==
É possível usar qualquer um dos exemplos abaixo dentro do `functions.php` do seu tema ou criando um plugin (veja como em [WordPress - Writing a Plugin](http://codex.wordpress.org/Writing_a_Plugin)).
= Adicionar um ícone no método de pagamento: =
/**
* Adicionar um ícone para Cobre Grátis.
*
* @param string $url String vazia.
*
* @return string Link para o seu ícone.
*/
function custom_woocommerce_cobregratis_icon( $url ) {
return 'link do ícone';
}
add_filter( 'woocommerce_cobregratis_icon', 'custom_woocommerce_cobregratis_icon' );
= Alterar os parametros postados para o Cobre Grátis: =
/**
* Customizar os dados postados para o Cobre Grátis.
*
* @param array $data Dados gerados pelo plugin.
* @param WC_Order $order Objeto que contém todas as informações do pedido.
*
* @return array
*/
function custom_woocommerce_cobregratis_billet_data( $data, $order ) {
// aqui você pode trabalhar e alterar o array $data com o que desejar.
// Api do Cobre Grátis: https://github.com/Cobre Grátis/cobregratis-api
return $data;
}
add_filter( 'woocommerce_cobregratis_billet_data', 'custom_woocommerce_cobregratis_billet_data', 10, 2 );
= Alterar as instruções do boleto na página de "obrigado" (thankyou page): =
/**
* Customizar as instruções sobre o boleto na página "obrigado".
*
* @param string $message Mensagem padrão do plugin.
* @param int $order_id ID do pedido.
*
* @return string Novas instruções.
*/
function custom_woocommerce_cobregratis_thankyou_page_instructions( $message, $order_id ) {
return 'Novas instruções';
}
add_filter( 'woocommerce_cobregratis_thankyou_page_instructions', 'custom_woocommerce_cobregratis_thankyou_page_instructions', 10, 2 );
= Alterar as instruções do boleto no e-mail: =
/**
* Customizar as instruções sobre o boleto no e-mail.
*
* @param string $message Mensagem padrão do plugin.
* @param WC_Order $order Objeto que contém todas as informações do pedido.
*
* @return string Novas instruções.
*/
function custom_woocommerce_cobregratis_email_instructions( $message, $order ) {
return 'Novas instruções';
}
add_filter( 'woocommerce_cobregratis_email_instructions', 'custom_woocommerce_cobregratis_email_instructions', 10, 2 );
= Alterar as instruções do boleto para pedidos que estão aguardando pagamento: =
/**
* Customizar as instruções do boleto para pedidos que estão aguardando pagamento.
*
* @param string $message Mensagem padrão do plugin.
* @param WC_Order $order Objeto que contém todas as informações do pedido.
*
* @return string Novas instruções.
*/
function custom_woocommerce_cobregratis_pending_payment_instructions( $message, $order ) {
return 'Novas instruções';
}
add_filter( 'woocommerce_cobregratis_pending_payment_instructions', 'custom_woocommerce_cobregratis_pending_payment_instructions', 10, 2 );
== Screenshots ==
1. Plugin Settings.
== Changelog ==
= 1.0.1 - 17/05/2014 =
* Corrigida a geração de boletos.
= 1.0.0 =
* Versão inicial.
== Upgrade Notice ==
= 1.0.1 =
* Corrigida a geração de boletos.
== License ==
Cobre Grátis 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.
Cobre Grátis 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 Cobre Grátis WooCommerce. If not, see <http://www.gnu.org/licenses/>.