AVISO: Os formulários de doação recém-criados são registrados como V2. Por favor, consulte o texto de ajuda relacionado ao V2. Os formulários de doação neste documento pertencem a uma versão antiga!
O que é um formulário de doação?
Os formulários de doação são uma infraestrutura que permite receber doações ao integrá-los ao seu próprio site. Você pode criar um formulário de doação acessando a seção Doações > Formulário de Doação no menu à esquerda.
O que devo observar?
O ponto mais importante a ser observado ao criar um formulário de doação é inserir o endereço do site onde você usará o formulário. Ao inserir o endereço, você deve incluir https:// no início. E se o seu site tiver várias versões, você deve torná-lo único. Os formulários de doação só funcionam com HTTPS.
Por exemplo;
Se o seu site funciona como https://www.adimadim.org e https://adimadim.org, por favor, escolha apenas um e redirecione o domínio que você não escolheu para o outro.
Integração do site
AVISO! Esta integração requer conhecimento de software. Você precisa ter domínio básico de HTML e Javascript. Se você não tem domínio desses assuntos, por favor, use nossas páginas de doação padrão.
Primeiro, você pode obter a chave API (api_key) e o Código da Campanha (campaign), que são necessários para usar o formulário em sua página, na seção Ações > Informações de Integração na lista de formulários de doação.
Imediatamente antes da seção </head> da sua página web
<meta name="Referrer" content="origin"><script type="text/javascript" src="https://s.fonzip.com/js/fonzip.loader.js"></script>
adicione nosso script à página.
Depois de preparar as seções em sua página web onde você receberá os parâmetros de valor e doação recorrente, você deve chamar a função fz.bagis ao clicar no botão de doação.
Parâmetros
api_key: Sua Chave API (Obrigatório)
amount: Valor da Doação (Obrigatório)
currency: Código ISO da moeda, por padrão a moeda da instituição,
recurring: É Doação Recorrente? (Obrigatório)
campaign: Seu Código de Campanha (Obrigatório)
lang: Vazio ou "tr" para Turco, "en" para Inglês, por padrão o idioma do navegador
get_news: Concessão de permissão de comunicação, true se concedida, false se não concedida
referring: Se desejar que a opção de doação em nome de alguém seja selecionada, true, caso contrário false
cardholder_name: Se desejar que o nome completo do doador seja preenchido, deve ser preenchido
email: Se desejar que o endereço de e-mail seja preenchido, deve ser preenchido
ref_to: Se desejar que o nome da pessoa em nome de quem a doação será feita seja preenchido, deve ser preenchido
ref_email: Se desejar que o e-mail da pessoa em nome de quem a doação será feita seja preenchido, deve ser preenchido
tckno: Se desejar que o CPF/identificação seja preenchido, deve ser preenchido, deve ter 11 dígitos
phone: Se desejar que o telefone seja preenchido, deve ser preenchido, deve conter apenas números
birthday: Data de nascimento, deve estar no formato DD/MM/AAAA e deve ser preenchida se desejar que venha preenchida
details: Campo de descrição, deve ser preenchido se desejar que venha preenchido
api_tracking_id: Código necessário para rastrear o formulário aberto
fundraising_campaign_id: Deve ser enviado se desejar que o formulário aberto seja vinculado a uma campanha de usuário
name_hidden: O nome deve ser ocultado na doação feita para a campanha do usuário?
amount_visible: O valor da doação deve ser visível na doação feita para a campanha do usuário?
custom_parameters: Seus parâmetros personalizados
onload: Ações que você deseja que sejam executadas em sua página quando o formulário de doação for aberto
success: Ações que você deseja que sejam executadas em sua página quando a doação for concluída, retorna as informações da doação bem-sucedida
error: Ações que você deseja que sejam executadas em sua página quando a doação falhar
close: Ações que você deseja que sejam executadas em sua página quando o formulário for fechado; se for fechado após uma doação bem-sucedida, o parâmetro result retorna true.
fz.bagis({ api_key: "API ANAHTARINIZ", amount: "Miktar", currency: "TRY", recurring: false || true, campaign: "KAMPANYA KODUNUZ", lang:"tr", // get_news: true, referring: false, cardholder_name: "Nome completo do doador", email: "Endereço de e-mail", ref_to: "Nome da pessoa em nome de quem a doação será feita", ref_email: "E-mail da pessoa em nome de quem a doação será feita", tckno: "CPF/Identificação", phone: "Telefone", birthday: "DD/MM/AAAA", details: "Descrição", api_tracking_id: "Código de Rastreamento", fundraising_campaign_id: "ID da campanha do usuário", name_hidden: false || true, amount_visible: false || true, custom_parameters: { //seus parâmetros personalizados }, onload: function() { //AÇÕES A SEREM EXECUTADAS QUANDO O CARREGAMENTO FOR CONCLUÍDO }, success: function(data) { var nome_doador = data.name; var valor_doacao = data.amount; var email_doador = data.email; var campanha = data.campaign_id; var endereco = data.address; var telefone = data.phone; var tckno = data.tckno; var data_nascimento = data.birthday; var cidade = data.city; var distrito = data.district; var descricao = data.details; var tckno = data.tckno; var em_nome_de_alguem = data.referring; var pessoa_em_nome_da_doacao = data.referring_name; var email_pessoa_em_nome_da_doacao = data.referring_email; var recorrente = data.recurring; var numero_transacao = data.order_id; var numero_transacao_bancaria = data.transaction_id; var numero_providencia_bancaria = data.provision_no; var api_tracking_id = data.api_tracking_id; // AÇÕES A SEREM EXECUTADAS QUANDO BEM-SUCEDIDO }, error: function(data) { var codigo_erro = data.error_code; var descricao_erro = data.error_description; // AÇÕES A SEREM EXECUTADAS QUANDO MAL-SUCEDIDO }, close: function(result) { //se true, doação bem-sucedida, caso contrário outras situações //Ações a serem executadas quando o formulário for fechado }});Parâmetros Personalizados
Você pode usar a funcionalidade de parâmetros personalizados para transferir qualquer campo que não esteja definido no Fonzip, mas que você use ao receber doações, para o Fonzip.
Criação de Parâmetros Personalizados
Você pode criar um parâmetro clicando em Adicionar parâmetro na seção Parâmetros Personalizados, localizada na parte inferior da página de criação/edição do formulário de doação.
Na tela que aparece, digite o valor da chave que você passará no parâmetro na seção Nome do campo, e o valor que você deseja que apareça no sistema na seção Descrição, e salve.
Por exemplo, criamos um parâmetro com o nome de campo recibo e a descrição Pedido de Recibo. Se o doador desejar um recibo adicional, preencheremos este campo como "Sim"; se não desejar, como "Não".
Nota: Não há restrições nos valores a serem passados nos parâmetros.
Ao enviar uma solicitação de doação, você deve enviar seu parâmetro na função fz.bagis da seguinte forma:
var valor_recibo = makbuz_checkbox.selected ? "Sim":"Não";fz.bagis({ api_key: "API ANAHTARINIZ", amount: "miktar", currency: "TRY", recurring: false, campaign: "KAMPANYA KODUNUZ", custom_parameters: { makbuz: valor_recibo }, success: function(data) { // AÇÕES A SEREM EXECUTADAS QUANDO BEM-SUCEDIDO }, error: function(data) { // AÇÕES A SEREM EXECUTADAS QUANDO MAL-SUCEDIDO }});Após a conclusão da doação, se a opção de recibo for selecionada, você poderá ver os dados relevantes nos detalhes da doação, conforme abaixo.
Advertências de Parâmetros Personalizados
O envio de um parâmetro não definido nas configurações do formulário causará um erro no sistema.
O envio de dados fora do formato JSON causará um erro no sistema.
Ao alterar/excluir o nome de campo de um parâmetro que você adicionou anteriormente, você pode perder os dados das doações relacionadas.
Código de Exemplo
Você pode acessar arquivos de exemplo HTML, CSS e Javascript em https://bitbucket.org/erdifonzip/fonzip-donation-form-integration.