PHPackages                             lucashtc/yampi-php-sdk - 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. lucashtc/yampi-php-sdk

ActiveLibrary[API Development](/categories/api)

lucashtc/yampi-php-sdk
======================

SDK Não oficial da API da plataforma de e-commerce Yampi.

043PHP

Since Nov 19Pushed 1y agoCompare

[ Source](https://github.com/lucashtc/yampi-php-sdk)[ Packagist](https://packagist.org/packages/lucashtc/yampi-php-sdk)[ RSS](/packages/lucashtc-yampi-php-sdk/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Yampi-PHP-SDK
=============

[](#yampi-php-sdk)

SDK oficial da plataforma de e-commerce [Yampi](https://yampi.com.br).

Principais Recursos
-------------------

[](#principais-recursos)

- Recurso de Login com JWT e Tokens de usuário.
- Recurso de Requests.

Dependências
------------

[](#dependências)

- PHP >= 7.1

Instalação via Composer
-----------------------

[](#instalação-via-composer)

```
$ composer require somosyampi/yampi-php-sdk
```

Utilizando a SDK
----------------

[](#utilizando-a-sdk)

Você pode autenticar sua aplicação utilizando JWT (JSON Web Tokens).

```
require 'vendor/autoload.php';

use Yampi\Api\AuthRequest;
use Yampi\Api\Exceptions\RequestException;
use Yampi\Api\Exceptions\ValidationException;

// Configure seu ambiente.
$yampiApi = AuthRequest::production();

// Configure sua loja.
$yampiApi->setMerchant('aliasDeSuaLoja');

try {
    // Faz o login por credenciais.
    $auth = $yampiApi->login(['email' => 'email@sualoja.com.br', 'password' => 'senha']);

    $type = $auth->getAuthTokenType(); // bearer

    $JWT = $auth->getAuthToken(); //eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...
} catch (ValidationException $e) {
    // Erro de validação dos inputs

    // Mensagens de erros
    $errors = $e->getErrors();

} catch (RequestException $e) {
    // Credenciais inválidas.
}
```

Caso você você já possua um JWT.

```
use Yampi\Api\AuthRequest;

// Seu JWT.
$JWT = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...';

// Configure seu JWT, seu ambiente e faz o login por JWT.
$yampiApi = AuthRequest::production()->setJwt($JWT);
```

Outra maneira de autenticação é pelo `token de usuário`:

```
require 'vendor/autoload.php';

use Yampi\Api\AuthRequest;
use Yampi\Api\Exceptions\RequestException;

// Configure seu ambiente.
$yampiApi = AuthRequest::production();

// Configure sua loja.
$yampiApi->setMerchant('aliasDeSuaLoja');

// Configure seu token de usuário.
$yampiApi->setUserToken('seuTokenDeUsuário');

try {
    // Requests...
} catch (RequestException $e) {
    // Token de usuário inválido.
}
```

Uma vez autenticado, você já pode consumir a API da Yampi utilizando este SDK.

```
use Yampi\Api\AuthRequest;

// Busque seu JWT.
$jwt = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...';

// Configure seu JWT, seu ambiente e sua loja.
$yampiApi = AuthRequest::production()
    ->setJwt($jwt);
    ->setMerchant('aliasDeSuaLoja');

// Busca o catalogo de produtos da sua loja na Yampi.
$response = $yampiApi->request('GET', '/catalog/products');
// Ou
$response = $yampiApi->catalog()->products()->get();

$response->getData(); // array
```

Métodos que facilitam os recursos de pesquisa e filtros.

```
// Busque seu JWT.
$jwt = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...';

// Configure seu JWT, seu ambiente e sua loja.
$yampiApi = AuthRequest::production()
    ->setJwt($jwt)
    ->setMerchant('aliasDeSuaLoja');

// Filtra por página.
$yampiApi->page(2);

// Filtra por qualquer campo e altera o formato de busca dos campos sendo filtrados (LIKE).
$yampiApi->search(['name' => 'Roupa de Cama']);
$yampiApi->searchFields(['name' => 'like']);

// Filtra por data de criação (created_at)...
$yampiApi->period('2018-01-01', '2018-01-31');
// ...ou por qualquer campo de data.
$yampiApi->period('2018-01-01', '2018-01-31', 'any_date_field');

// Ordena por qualquer campos e altera a direção de orderação dos campos sendo ordenados.
$yampiApi->orderBy('name');
$yampiApi->sortedBy('desc');

// Altera o limite da paginação (máximo é 100).
$yampiApi->limit(20);

// Ignora o cache.
$yampiApi->skipCache();

// Retorna os produtos do catálogo com os filtros aplicados
$response = $yampiApi->request('GET', '/catalog/products');
// Ou
$response = $yampiApi->catalog()->products()->get();

$response->getData(); // array
```

Se preferir, pode encadear todas as chamadas diretamente:

```
$catalogProducts = AuthRequest::production()
    ->setJwt($jwt)
    ->setMerchant('aliasDeSuaLoja')
    ->page(2)
    ->search(['name' => 'Roupa de Cama'])
    ->searchFields(['name' => 'like'])
    ->period('2018-01-01', '2018-01-31', 'created_at')
    ->orderBy('name')
    ->sortBy('desc')
    ->limit(20)
    ->skipCache()
    ->get();
```

### Paginação

[](#paginação)

```
// ...
$response = $response->getData();
$pagination = $response->pagination();

$pagination->getTotal(); // Retorna o total de registros
$pagination->getPerPage(); // Retorna o total de registros por página
$pagination->getCurrentPage(); // Retorna a página atual
$pagination->getTotalPages(); // Retorna a quantidade total de páginas
$pagination->getNextLink(); // Retorna a URL da próxima página
$pagination->getPreviousLink(); // Retorna a URL da página anterior
```

Change Log
----------

[](#change-log)

Consulte [CHANGELOG](.github/CHANGELOG.md) para obter mais informações sobre o que mudou recentemente.

Contribuições
-------------

[](#contribuições)

Consulte [CONTRIBUTING](.github/CONTRIBUTING.md) para obter mais detalhes.

Segurança
---------

[](#segurança)

Se você descobrir quaisquer problemas relacionados à segurança, envie um e-mail para  em vez de usar as issues.

###  Health Score

17

—

LowBetter than 6% of packages

Maintenance31

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity16

Early-stage or recently created project

 Bus Factor1

Top contributor holds 65.8% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/5940ca7c0f648fae5033f58d9a147130e421051f4a424aa0b5596b8e15189839?d=identicon)[lucashtc](/maintainers/lucashtc)

---

Top Contributors

[![lucascolette](https://avatars.githubusercontent.com/u/829381?v=4)](https://github.com/lucascolette "lucascolette (73 commits)")[![gabrielboliveira](https://avatars.githubusercontent.com/u/11093090?v=4)](https://github.com/gabrielboliveira "gabrielboliveira (17 commits)")[![welderls](https://avatars.githubusercontent.com/u/12821977?v=4)](https://github.com/welderls "welderls (7 commits)")[![lucashtc](https://avatars.githubusercontent.com/u/17412763?v=4)](https://github.com/lucashtc "lucashtc (5 commits)")[![welderlourenco](https://avatars.githubusercontent.com/u/5265316?v=4)](https://github.com/welderlourenco "welderlourenco (5 commits)")[![GuiAndra](https://avatars.githubusercontent.com/u/15656816?v=4)](https://github.com/GuiAndra "GuiAndra (3 commits)")[![EduardoNakatsuka](https://avatars.githubusercontent.com/u/43795015?v=4)](https://github.com/EduardoNakatsuka "EduardoNakatsuka (1 commits)")

### Embed Badge

![Health badge](/badges/lucashtc-yampi-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/lucashtc-yampi-php-sdk/health.svg)](https://phpackages.com/packages/lucashtc-yampi-php-sdk)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M270](/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)[microsoft/microsoft-graph

The Microsoft Graph SDK for PHP

65723.5M95](/packages/microsoft-microsoft-graph)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)

PHPackages © 2026

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