> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lomadee.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Changelog

> Principais mudanças da Affiliate API

## August 2026 — Partner API (catalog)

New REST surface for catalog partners. `/affiliate/*` is **not** deprecated.

* `GET /api/partner/brands` and `GET /api/partner/brands/{brandId}` — visible brands, no short URLs or commission
* `GET /api/partner/campaigns` and `GET /api/partner/campaigns/{campaignId}` — offers and coupons; `PersonalCoupon` without `code`
* Auth: `x-api-key` type `partner` with scopes `organizations:read`, `brands:read`, `campaigns:read`
* Docs: [Partner API](/docs/partner-api/overview) tab

## Junho 2026 — Nova API pública (open-api)

Atualização da infraestrutura da API affiliate. **Os paths e o formato das respostas foram mantidos** — integrações existentes continuam válidas, com reforço de segurança, limites e documentação alinhada ao comportamento real.

### O que mudou para você

**URL base**

* A API será disponibilizada em **`https://api.lomadee.com.br`**.
* O host atual **`https://api-beta.lomadee.com.br`** continua funcionando durante a transição, mas **será descontinuado em breve**.
* Atualize a URL base nas suas integrações antes do cutover; paths, autenticação e respostas permanecem iguais.

**Autenticação e chaves**

* Chaves legadas (32 caracteres) continuam funcionando durante a transição.
* Novo formato de chave: `lmd_{env}_{prefix}_{secret}` — recomendado para novas integrações.
* Cada endpoint exige o **escopo** correto na chave (`brands:read`, `orders:read`, etc.). Sem o escopo, a API retorna `403`.
* Documentação de escopos: [API Keys](/api-reference/api-keys).

**Rate limit**

* Limite global: **60 requisições / 60 segundos** por chave + IP do cliente.
* Respostas incluem headers `X-RateLimit-Limit`, `X-RateLimit-Remaining` e `X-RateLimit-Reset`.
* Ao exceder o limite: `429` com `Retry-After` e headers de rate limit.

**Paginação e filtros**

* `limit` máximo **20** em brands, campaigns e channels (listagens com geração de links). Valores acima de 20 são **reduzidos silenciosamente** para 20.
* Orders, shortener e partner: `limit` máximo **100** (clamp silencioso acima de 100).
* Products: `limit` menor que 1 ou maior que 100 retorna **400**.
* Products: resposta `{ data, count }` — default `limit=5` (não `meta`).
* Channels: lista retorna no máximo **20** canais por request.

**Endpoints**

* **Offers removidos** (`/affiliate/offers`). Use `GET /affiliate/campaigns` com filtro `types=Offer`.
* **Channels documentados**: `GET /affiliate/channels` e `GET /affiliate/channels/{id}`.
* `POST /affiliate/shortener/url`: validação mais estrita — campos desconhecidos no body retornam `400`.

**Documentação**

* OpenAPI e páginas MDX revisados para refletir o contrato real da API.
* Paginação documentada por recurso em [Introduction](/api-reference/introduction).

### O que não muda

* Header de autenticação: `x-api-key`.
* Paths affiliate: `/affiliate/brands`, `/affiliate/campaigns`, `/affiliate/orders`, `/affiliate/products`, `/affiliate/shortener/*`.
* Envelopes de resposta por recurso (`pagination`, `meta` ou `count` conforme o endpoint).

### Ação recomendada

1. Planejar migração de `api-beta.lomadee.com.br` para **`api.lomadee.com.br`** — o beta deixará de existir em breve.
2. Revisar [API Keys](/api-reference/api-keys) e confirmar que sua chave tem os escopos necessários.
3. Tratar resposta `429` usando `Retry-After`.
4. Se usava `/affiliate/offers`, migrar para `/affiliate/campaigns`.
5. Validar paginação: não enviar `limit` acima de 100; em products, manter entre 1 e 100.

### Suporte

Dúvidas ou comportamento inesperado: [help.lomadee.com.br](https://help.lomadee.com.br).