Pricing

Rating

Developer

Actor stats

Categories

Share

🛒 Rakuten Advertising API — Merchants, Coupons & Products (BYOC)

🔗 View on Apify Store | 🇺🇸 English | 🇧🇷 Português

Query the Rakuten Advertising Publisher API for affiliate merchants, active coupons, and product search results. BYOC (Bring Your Own Credentials) — bring your free Rakuten publisher credentials and we proxy queries with 98% margin. ToS-compliant, anti-bot immune (official API).

✨ Features

• 3 query types — productSearch (find products across merchants), coupons (active deals), advertisers (joinable merchants)
• Dual auth modes — OAuth client_credentials grant OR pre-generated access token from Rakuten Developer Portal
• XML response parsing — regex-based extractor (no lxml dependency)
• Multi-network support — same actor queries US, UK, AU, BR, DE Rakuten networks (pass appropriate siteId)
• Auto-pagination for productSearch (up to 1000 records per run)
• NEVER 0 ITEMS guard — fails loud if Rakuten returns empty, never silent SUCCEEDED with no data
• Owner-skip pattern — internal runs (owner) bypass PPE charge

🔑 BYOC setup (one-time, free, ~10 min)

1. Sign up at https://developers.rakutenadvertising.com (or use your existing Publisher account)
2. Applications → Create New App → copy Client ID + Client Secret
3. Find your Site ID in Rakuten Advertising account (7-digit number)
4. Two paths to authenticate:
   • Path A (OAuth): paste clientId + clientSecret + siteId in actor input. Actor does the OAuth client_credentials exchange automatically.
   • Path B (pre-generated token): in Developer Portal click "Generate Token" → paste resulting JWT in accessToken input. Use this if Path A fails with invalid_client (some app states require manual activation).

Limits: free tier provides standard publisher API quotas — typically 1 request/second, 10K/day. Plenty for affiliate research.

📥 Input

Example input (Path B — pre-generated token, simpler)

{
"siteId":"4703080",
"accessToken":"your-token-from-rakuten-portal",
"queryType":"productSearch",
"keyword":"running shoes",
"maxResults":50
}

Example input (Path A — OAuth flow)

{
"clientId":"your-rakuten-client-id",
"clientSecret":"your-rakuten-client-secret",
"siteId":"4703080",
"queryType":"coupons",
"keyword":"fashion",
"maxResults":100
}

📤 Output

productSearch records

{
"queryType":"productSearch",
"productName":"Nike Air Max 90 - Running Shoe",
"merchantId":"39247",
"merchantName":"Nike US",
"advertiserCategory":"Athletic Apparel",
"price":"129.99",
"currency":"USD",
"salePrice":null,
"linkUrl":"https://click.linksynergy.com/...",
"imageUrl":"https://cdn.example.com/...",
"description":"...",
"sku":"AIRMAX-90-US-10",
"scrapedAt":"2026-05-15T13:45:00.000Z"
}

coupons records

{
"queryType":"coupons",
"offerId":"12345",
"merchantId":"39247",
"merchantName":"Nike US",
"offerText":"20% off Running Shoes",
"couponCode":"RUN20",
"startDate":"2026-05-01",
"endDate":"2026-05-31",
"linkUrl":"https://click.linksynergy.com/...",
"categories":["Apparel"]
}

advertisers records

{
"queryType":"advertisers",
"merchantId":"39247",
"merchantName":"Nike US",
"applicationStatus":"OPEN",
"commissionTerms":"8% on sale",
"categories":["Apparel","Sports"],
"currency":"USD",
"country":"US"
}

💰 Pricing

Pay-per-event (PPE): only charged when a real record is returned. Zero results → zero charge. Owner-skip pattern ensures internal runs are not charged.

🚀 Use cases

• Affiliate program discovery — find Rakuten merchants you can join (e.g., Nike US, Macy's, Walmart, Booking.com)
• Coupon aggregation — power your coupon site with live Rakuten deals
• Product catalog import — seed your comparison or affiliate site
• Price intelligence — track merchant pricing across Rakuten network
• Compliance research — survey affiliate commission terms across verticals

⚠️ Common errors

🔒 Privacy & security

Your clientSecret and accessToken are passed directly to api.linksynergy.com over HTTPS. Apify Console marks the fields as isSecret: true so the values are masked in logs and dataset. We never store, log, or proxy them through our servers.

📚 Related actors

• CJ Affiliate Products — Commission Junction API (BYOC)
• Impact.com Affiliate Network — Impact REST API (BYOC)
• Awin Multi-Merchant Affiliate — Awin Publisher API (BYOC)
• ShareASale Publisher (BYOC) — ShareASale Affiliate API (BYOC)

🆕 Changelog

• v1.0 (2026-05-14): Initial release. 3 query types, dual auth (OAuth + pre-generated JWT), XML regex parser, auto-pagination, owner-skip PPE, NEVER 0 ITEMS guard.

Português

🛒 Rakuten Advertising API — Merchants, Coupons & Products (BYOC)

Consulta a API oficial Rakuten Advertising Publisher para descobrir merchants, cupons ativos e produtos. BYOC (Bring Your Own Credentials) — você traz suas credenciais grátis Rakuten e nós fazemos as queries com margem 98%. ToS-compliant, sem anti-bot (API oficial).

Diferencial vs scraping anti-bot

• Sem 403/429 — API oficial endorsada pelo Rakuten
• Sem proxy residencial caro — API REST direta
• 98% de margem PPE
• Dados estruturados (XML parseado para JSON limpo)

✨ Funcionalidades

• 3 tipos de consulta — productSearch (encontra produtos entre merchants), coupons (ofertas ativas), advertisers (merchants que aceitam novos publishers)
• Dois modos de autenticação — OAuth client_credentials grant OU token de acesso pré-gerado no Rakuten Developer Portal
• Parsing de resposta XML — extrator baseado em regex (sem dependência de lxml)
• Suporte multi-rede — o mesmo actor consulta as redes Rakuten dos EUA, Reino Unido, Austrália, Brasil e Alemanha (passe o siteId apropriado)
• Auto-paginação para productSearch (até 1000 registros por execução)
• Guard NEVER 0 ITEMS — falha de forma explícita se o Rakuten retorna vazio, nunca um SUCCEEDED silencioso sem dados
• Padrão owner-skip — execuções internas (do owner) não passam pela cobrança PPE

🔑 Setup BYOC (uma vez, grátis, ~10 min)

1. Cadastre-se em https://developers.rakutenadvertising.com (ou use sua conta Publisher existente)
2. Applications → Create New App → copie Client ID + Client Secret
3. Encontre seu Site ID na conta Rakuten Advertising (número de 7 dígitos)
4. Dois caminhos de autenticação:
   • Caminho A (OAuth): cole clientId + clientSecret + siteId no input do actor. O actor faz a troca OAuth client_credentials automaticamente.
   • Caminho B (token pré-gerado): no Developer Portal clique "Generate Token" → cole o JWT resultante no input accessToken. Use isso se o Caminho A falhar com invalid_client (alguns estados de app exigem ativação manual).

Limites: o free tier fornece as quotas padrão da API de publisher — tipicamente 1 requisição/segundo, 10K/dia. Mais que suficiente para pesquisa de afiliados.

📥 Entrada

Exemplo de input (Caminho B — token pré-gerado, mais simples)

{
"siteId":"4703080",
"accessToken":"your-token-from-rakuten-portal",
"queryType":"productSearch",
"keyword":"running shoes",
"maxResults":50
}

Exemplo de input (Caminho A — fluxo OAuth)

{
"clientId":"your-rakuten-client-id",
"clientSecret":"your-rakuten-client-secret",
"siteId":"4703080",
"queryType":"coupons",
"keyword":"fashion",
"maxResults":100
}

📤 Saída

Registros productSearch

{
"queryType":"productSearch",
"productName":"Nike Air Max 90 - Running Shoe",
"merchantId":"39247",
"merchantName":"Nike US",
"advertiserCategory":"Athletic Apparel",
"price":"129.99",
"currency":"USD",
"salePrice":null,
"linkUrl":"https://click.linksynergy.com/...",
"imageUrl":"https://cdn.example.com/...",
"description":"...",
"sku":"AIRMAX-90-US-10",
"scrapedAt":"2026-05-15T13:45:00.000Z"
}

Registros coupons

{
"queryType":"coupons",
"offerId":"12345",
"merchantId":"39247",
"merchantName":"Nike US",
"offerText":"20% off Running Shoes",
"couponCode":"RUN20",
"startDate":"2026-05-01",
"endDate":"2026-05-31",
"linkUrl":"https://click.linksynergy.com/...",
"categories":["Apparel"]
}

Registros advertisers

{
"queryType":"advertisers",
"merchantId":"39247",
"merchantName":"Nike US",
"applicationStatus":"OPEN",
"commissionTerms":"8% on sale",
"categories":["Apparel","Sports"],
"currency":"USD",
"country":"US"
}

💰 Preços

Pay-per-event (PPE): só cobra quando um registro real é retornado. Zero resultados → zero cobrança. O padrão owner-skip garante que execuções internas não sejam cobradas.

🚀 Casos de Uso

• Descoberta de programas de afiliados — encontre merchants Rakuten aos quais você pode se filiar (ex.: Nike US, Macy's, Walmart, Booking.com)
• Agregação de cupons — abasteça seu site de cupons com ofertas Rakuten ao vivo
• Importação de catálogo de produtos — popule seu site de comparação ou de afiliados
• Inteligência de preços — acompanhe os preços dos merchants na rede Rakuten
• Pesquisa de compliance — levante os termos de comissão de afiliados entre verticais

⚠️ Erros comuns

🔒 Privacidade e segurança

Seu clientSecret e accessToken são passados diretamente para api.linksynergy.com sobre HTTPS. O Apify Console marca os campos como isSecret: true, de modo que os valores ficam mascarados nos logs e no dataset. Nós nunca armazenamos, logamos ou intermediamos esses valores pelos nossos servidores.

📚 Actors Relacionados

• CJ Affiliate Products — API da Commission Junction (BYOC)
• Impact.com Affiliate Network — API REST da Impact (BYOC)
• Awin Multi-Merchant Affiliate — API Publisher da Awin (BYOC)
• ShareASale Publisher (BYOC) — API de Afiliados da ShareASale (BYOC)

🆕 Histórico de Versões

• v1.0 (2026-05-14): Lançamento inicial. 3 tipos de consulta, autenticação dupla (OAuth + JWT pré-gerado), parser XML por regex, auto-paginação, PPE com owner-skip, guard NEVER 0 ITEMS.