/php

Biblioteca de integração em PHP

Primary LanguagePHP

Biblioteca de integração PagSeguro para PHP

Code Climate

Descrição

A biblioteca PagSeguro em PHP é um conjunto de classes de domínio que facilitam, para o desenvolvedor PHP, a utilização das funcionalidades que o PagSeguro oferece na forma de APIs. Com a biblioteca instalada e configurada, você pode facilmente integrar funcionalidades como:

Requisitos

Instalação

  • Baixe o repositório como arquivo zip ou faça um clone;
  • Descompacte os arquivos em seu computador;
  • Dentro do diretório source existem dois diretórios: o examples e o PagSeguroLibrary. O diretório examples contém exemplos de chamadas utilizando a API e o diretório PagSeguroLibrary contém a biblioteca propriamente dita. Caso queira importar somente a biblioteca, faça upload do diretório PagSeguroLibrary e inclua a classe PagSeguroLibrary.php em seu projeto. Essa classe se encarregará de importar todas as funcionalidades da biblioteca no seu sistema.

Instalação via Composer

{
    "require": {
       "pagseguro/php": "@stable"
    }
}

Configuração

Para fazer uso real da biblioteca, é preciso fazer algumas configurações no arquivo 'PagSeguroConfig.php', que encontra-se no diretório 'config'. As opções disponíveis estão descritas abaixo.

  • environment: aceita os valores production e sandbox. Para utilizar o sandbox, é preciso criar uma conta em https://sandbox.pagseguro.uol.com.br.
  • email: e-mail cadastrado no PagSeguro.
  • token production: token gerado no PagSeguro.
  • token sandbox: token gerado no Sandbox.
  • appId production: aplicacao gerada no PagSeguro.
  • appId sandbox: aplicacao gerada no Sandbox.
  • appKey production: token da aplicacao no PagSeguro.
  • appKey sandbox: token da aplicacao no Sandbox.
  • charset: codificação do seu sistema (ISO-8859-1 ou UTF-8).
  • log: ativa/desativa a geração de logs.
  • fileLocation: local onde se deseja criar o arquivo de log. Ex.: /logs/ps.log.

Mais informações estão disponíveis na documentação oficial.

Dúvidas?


Caso tenha dúvidas ou precise de suporte, acesse nosso fórum.

Changelog

2.7.1

  • Possibilidade de definir parcelamento sem juros.
  • Ajustes em geral.

2.7.0

  • Integração com serviço de consulta de Assinaturas (PreApproval) por código de notificação.

2.6.0

  • Env Variables para integração com Laravel 5 #0a2c2ba
  • Wrapper para o arquivo de configuração #c1b0985
  • Implementação da API de assinaturas #7cd8147
  • Integração com serviço de solicitação de cancelamento.
  • Ajustes em geral.
  • Obs.: Algumas das funcionalidades descritas ainda não estão disponíveis comercialmente para todos os vendedores. Em caso de dúvidas acesse nosso fórum.

2.5.0

  • Possibilidade de definir descontos por meio de pagamento durante a requisição do código de checkout - Ver exemplo createPaymentRequest.php

2.4.0

  • Integração com serviço de consulta de transações/autorizações por código de referência.
  • Integração com serviço de modelo de aplicações.
  • Integração com serviço de solicitação de estorno.
  • Ajustes em geral.
  • Obs.: As funcionalidades descritas acima ainda não estão disponíveis comercialmente para todos os vendedores. Em caso de dúvidas acesse nosso fórum.

2.3.0

  • Adicionado classes e métodos para utilização do Checkout Transparente.
  • As consultas por código de notificação e por código da transação passam a utilizar a nova versão das APIs.

2.2.4

  • Adicionado método setEnvironment na classe PagSeguroConfig
  • Melhorias na documentação/comentários do código
  • Ajustes diversos

2.2.3

  • Ajustes no código

2.2.2

  • Adicionando environment sandbox

2.2.1

  • Ajuste no tratamento do XML retornado em requisições feitas ao PagSeguro

2.2.0

  • Ao registrar a transação é possível obter apenas o código do checkout para utilização em um checkout lightbox (ver exemplo createPaymentRequestLightbox.php). Obs.: Esta funcionalidade ainda não está disponível comercialmente para todos os vendedores.

2.1.9

  • Melhorias "estéticas" no código, como identação/formatação.

2.1.8

  • Atualização dos códigos de meios de pagamento.
  • Melhoria na identificação dos requisitos mínimos para funcionamento.
  • Melhoria no tratamento de dados relacionados a endereço.

2.1.7

  • Adicionado: Classes para manipulação de metadados e parâmetros genéricos.

2.1.6

  • Adicionado: Classe para manipulação de documentos do sender, ex. CPF.

2.1.5

  • Adicionado: Funcionalidade de envio de url de notificação via requisição de checkout.
  • Adicionado: Novas funcionalidades para tratamento de dados no helper.
  • Correção: Tratamento de duplo espaço no sender name da requisição de checkout.

2.1.4

  • Adicionado: Classe para manipulação de moedas permitidas nas transações com o PagSeguro.

2.1.3

  • Correção: A requisição era abortada se a geração de log estivesse ativa e o usuário não possuisse arquivo para geração de log nem permissão de escrita e leitura para o arquivo.

2.0.0 - 2.1.2

  • Classes de domínios que representam pagamentos, notificações e transações.
  • Criação de checkouts via API.
  • Controller para processar notificações de pagamento enviadas pelo PagSeguro.
  • Módulo de consulta de transações.

Licença

Copyright 2013 PagSeguro Internet LTDA.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Notas

  • O PagSeguro somente aceita pagamento utilizando a moeda Real brasileiro (BRL).
  • Certifique-se que o email e o token informados estejam relacionados a uma conta que possua o perfil de vendedor ou empresarial.
  • Certifique-se que tenha definido corretamente o charset de acordo com a codificação (ISO-8859-1 ou UTF-8) do seu sistema. Isso irá prevenir que as transações gerem possíveis erros ou quebras ou ainda que caracteres especiais possam ser apresentados de maneira diferente do habitual.
  • Para que ocorra normalmente a geração de logs, certifique-se que o diretório e o arquivo de log tenham permissões de leitura e escrita.
  • Para a utilizar o checkout transparente, é necessária a solicitação de ativação junto com a equipe do PagSeguro, maiores informações podem ser encontradas em Como receber pagamentos pelo PagSeguro.

Dúvidas?

Em caso de dúvidas acesse nosso fórum.

Contribuições

Achou e corrigiu um bug ou tem alguma feature em mente e deseja contribuir?

  • Faça um fork
  • Adicione sua feature ou correção de bug (git checkout -b my-new-feature)
  • Commit suas mudanças (git commit -am 'Added some feature')
  • Rode um push para o branch (git push origin my-new-feature)
  • Envie um Pull Request
  • Obs.: Adicione exemplos para sua nova feature. Se seu Pull Request for relacionado a uma versão específica, o Pull Request não deve ser enviado para o branch master e sim para o branch correspondente a versão.