PHPackages                             lucasmro/clearsale - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. lucasmro/clearsale

ActiveLibrary[API Development](/categories/api)

lucasmro/clearsale
==================

ClearSale Integration

v1.9.0(8y ago)3314.1k25[2 PRs](https://github.com/lucasmro/ClearSale/pulls)MITPHPPHP >=5.3.0

Since Mar 2Pushed 2y ago3 watchersCompare

[ Source](https://github.com/lucasmro/ClearSale)[ Packagist](https://packagist.org/packages/lucasmro/clearsale)[ Docs](http://github.com/lucasmro/ClearSale)[ RSS](/packages/lucasmro-clearsale/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (4)Dependencies (1)Versions (12)Used By (0)

API ClearSale
=============

[](#api-clearsale)

**To read this document in English, please access the [README.eng.md](README.eng.md) file.**

[![Build Status](https://camo.githubusercontent.com/4243c978fb1ee5914281c5f71f2b88dab08137a7d64582da0eef46f1312c0477/68747470733a2f2f7472617669732d63692e6f72672f6c756361736d726f2f436c65617253616c652e706e67)](https://travis-ci.org/lucasmro/ClearSale)[![Latest Stable Version](https://camo.githubusercontent.com/1e842aa1af861b6733bb26f765a50c832554160e2eb8200d244794dd6bc93ada/68747470733a2f2f706f7365722e707567782e6f72672f6c756361736d726f2f636c65617273616c652f762f737461626c65)](https://packagist.org/packages/lucasmro/clearsale)[![Total Downloads](https://camo.githubusercontent.com/c6be3baabb04952e392c8edc398d0dcefc03ad0c5a1f929e57bdc013c541dda0/68747470733a2f2f706f7365722e707567782e6f72672f6c756361736d726f2f636c65617273616c652f646f776e6c6f616473)](https://packagist.org/packages/lucasmro/clearsale)[![Latest Unstable Version](https://camo.githubusercontent.com/73d5654771748681b1aec529ecd3a8bb327534dab619975004f1f16abe051ff0/68747470733a2f2f706f7365722e707567782e6f72672f6c756361736d726f2f636c65617273616c652f762f756e737461626c65)](https://packagist.org/packages/lucasmro/clearsale)[![License](https://camo.githubusercontent.com/77159b540013931f56841a980183a54bff62265c5d6f96b9a3388a5b9e588cf4/68747470733a2f2f706f7365722e707567782e6f72672f6c756361736d726f2f636c65617273616c652f6c6963656e7365)](https://packagist.org/packages/lucasmro/clearsale)

API de integração com a ClearSale.

O que é ClearSale?
------------------

[](#o-que-é-clearsale)

A Clearsale é uma empresa brasileira para gestão de risco de fraude que atua no mundo físico e virtual, com soluções para e-commerce, crédito, cobrança e recuperação de vendas.

Requisitos
----------

[](#requisitos)

PHP 5.3+

Instalação
----------

[](#instalação)

A maneira mais fácil de instalar a biblioteca é através do [Composer](http://getcomposer.org/).

```
{
    "require": {
        "lucasmro/clearsale": "dev-master"
    }
}
```

Fluxo de integração
-------------------

[](#fluxo-de-integração)

Este fluxo é responsável por demonstrar a integração entre o cliente e a ClearSale:

```
Loja                                                                 ClearSale
 |                                                                       |
 |----- (A) solicitação de análise de risco (sendOrders) --------------->|
 |                                                                       | (B) realiza processamento
 ||

```

- (A) A loja realiza uma solicitação de análise de risco, informando os dados da compra e do comprador.
- (B) A ClearSale processa a requisição.
- (C) A ClearSale responde a requisição.
- (D) Caso a resposta de (C) seja aprovada, a loja deverá realizar a cobrança.
- (D) Caso a resposta de (C) seja reprovada, a loja não deverá realizar a cobrança.
- (D) Caso a resposta de (C) seja aguardando aprovação, a loja deverá realizar novas consultas na plataforma na ClearSale até que o status da análise mude para aprovado ou reprovado.

Utilização
----------

[](#utilização)

Será necessário possuir o EntityCode fornecido pela ClearSale para poder realizar as requisições nos ambientes de homologação e produção.

O trecho de código abaixo é um exemplo básico de como realizar a solicitação de análise de risco:

```
try {
    $order = new \ClearSale\Order();
    $order->setFingerPrint($fingerPrint)
        ->setId($orderId)
        ->setDate($date)
        ->setEmail($email)
        ->setTotalItems($totalItems)
        ->setTotalOrder($orderTotal)
        ->setQuantityInstallments($quantityInstallments);
        ->setIp($ip);
        ->setOrigin($origin);
        ->setBillingData($customer)
        ->setShippingData($customer)
        ->setItems($items)
        ->setPayments($payments);

    // Definir ambiente
    $environment = new \ClearSale\Environment\Sandbox('');

    // Solicitação de análise
    $clearSale = new \ClearSale\ClearSaleAnalysis($environment);
    $response = $clearSale->analysis($order);

    // Resultado da análise
    switch ($response)
    {
        case \ClearSale\ClearSaleAnalysis::APROVADO:
            // Análise aprovou a cobrança, realizar o pagamento
            break;
        case \ClearSale\ClearSaleAnalysis::REPROVADO:
            // Análise não aprovou a cobrança
            break;
        case \ClearSale\ClearSaleAnalysis::AGUARDANDO_APROVACAO:
            // Análise pendente de aprovação manual
            break;
    }
} catch (\Exception $e) {
    // Erro genérico da análise
}
```

Após realizar a requisição de cobrança, deve-se informar a ClearSale sobre o status do processamento do pagamento.

- Se a cobrança for autorizada:

```
$clearSale->updateOrderStatusId($orderId, \ClearSale\ClearSaleAnalysis::APROVADO);
```

- Se a cobrança não for autorizada:

```
$clearSale->updateOrderStatusId($orderId, \ClearSale\ClearSaleAnalysis::REPROVADO);
```

Documentação
------------

[](#documentação)

Você pode encontrar a documentação de integração da ClearSale no diretório [docs](docs).

Exemplos
--------

[](#exemplos)

Você pode encontrar alguns exemplos prontos para uso no diretório [examples](examples).

- [Exemplo de pedido de E-Commerce](examples/ecommerce-order-example.php)
- [Exemplo de pedido de Passagem Aérea](examples/airline-ticket-order-example.php)

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity37

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 81% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~83 days

Recently: every ~74 days

Total

11

Last Release

3257d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/18bf60bca651a97d33eca95eab5fbd5841bcc4164e83fc47b6fce5689bc87862?d=identicon)[lucasmro](/maintainers/lucasmro)

---

Top Contributors

[![lucasmro](https://avatars.githubusercontent.com/u/2087945?v=4)](https://github.com/lucasmro "lucasmro (51 commits)")[![edsonlimadev](https://avatars.githubusercontent.com/u/6683189?v=4)](https://github.com/edsonlimadev "edsonlimadev (5 commits)")[![byjg](https://avatars.githubusercontent.com/u/981924?v=4)](https://github.com/byjg "byjg (3 commits)")[![alvescleiton](https://avatars.githubusercontent.com/u/5395864?v=4)](https://github.com/alvescleiton "alvescleiton (2 commits)")[![honjoya](https://avatars.githubusercontent.com/u/688954?v=4)](https://github.com/honjoya "honjoya (1 commits)")[![jojovem](https://avatars.githubusercontent.com/u/1272784?v=4)](https://github.com/jojovem "jojovem (1 commits)")

---

Tags

ClearSaleT-ClearSaleTG-ClearSaleA-ClearSale

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/lucasmro-clearsale/health.svg)

```
[![Health](https://phpackages.com/badges/lucasmro-clearsale/health.svg)](https://phpackages.com/packages/lucasmro-clearsale)
```

###  Alternatives

[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M271](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)[hubspot/api-client

Hubspot API client

23414.2M16](/packages/hubspot-api-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)