> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/integration/pt-br/data-api/api-overview.md). # Visão geral da API ## Como o Epsilon Retail Media funciona? A API é organizada em torno do REST. A API possui URLs previsíveis e orientadas a recursos e usa códigos de resposta HTTP para indicar erros da API. A API usa recursos HTTP integrados, incluindo autenticação HTTP e verbos HTTP, que são compreendidos por clientes HTTP prontos para uso. A autenticação na API é gerenciada por meio do uso de chaves de API. As chaves de API são usadas durante a comunicação entre seu backend e a API. A API de Integração suporta o envio de produtos, catálogos, clientes e dados de pedidos, que são usados para gerar anúncios. Você pode usar a API de Integração para solicitar anúncios e relatar interações com esses anúncios. ## Endpoints de integração Epsilon Retail Media usa vários endpoints para sincronizar dados e gerar anúncios. Um breve resumo é fornecido abaixo: | Endpoint | Uso | Descrição | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `catalogs` | [Syncing catalog via API](/retail-media-interface/integration/pt-br/data-api/catalog-products-2/syncing-catalog-via-api.md) | Usado para criar catálogos via API. Para namespaces de catálogo único, isso é algo que seu Gerente Técnico de Contas pode organizar para você. | | `catalog-products` | [Syncing products via API](/retail-media-interface/integration/pt-br/data-api/catalog-products-2/syncing-products-via-api.md) | Usado para criar e atualizar dados de produtos em um catálogo. | | `customers` | [Syncing customer data via API](/retail-media-interface/integration/pt-br/data-api/customer-data/syncing-customer-data-via-api-1.md) | Usado para criar e atualizar dados de clientes em um catálogo. | | `orders` | [Syncing order data via API](/retail-media-interface/integration/pt-br/data-api/order-data-1/syncing-order-data-via-api.md) | Usado para enviar dados de pedidos. | | `/resource/` | [Reporting impressions & clicks](/retail-media-interface/integration/pt-br/data-api/api-overview/reporting-impressions-clicks.md) [Syncing order data via API](/retail-media-interface/integration/pt-br/data-api/order-data-1/syncing-order-data-via-api.md) | Usado para relatar cliques e impressões, bem como pedidos se o relatório for feito via front-end. | | `/ads/generate` | Gerando anúncios | Usado para gerar anúncios de produtos e anúncios de banner. | | `/ads/bannerx` | Gerando anúncios | Usado para gerar anúncios de banner x. | {% hint style="info" %} Você não precisa usar endpoints para sincronização de catálogo, produto, cliente e pedido. Epsilon Retail Media suporta a sincronização de dados via arquivo, o que pode ser adequado para suas necessidades. {% endhint %} ## Tipo de conteúdo e payload O payload de dados está no formato JSON. O `Content-Type` para esses endpoints é `application/json`, que deve ser passado como um cabeçalho em suas requisições da seguinte forma: ``` -H "Content-Type: application/json" \ ``` ## Autenticando requisições ### Autenticação básica Todos os recursos de integração usam autenticação básica, que deve ser passada como um cabeçalho com sua chave de API da seguinte forma: ``` -H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \ ``` Sua chave de API pode ser acessada na seção Configurações de Integração da equipe do varejista. Você precisará apenas da chave secreta da API. ### Autenticação OAuth2.0 Epsilon Retail MediaO endpoint de geração de anúncios do também é compatível com OAuth2.0. Revise [Autenticação OAuth 2.0](/retail-media-interface/integration/pt-br/data-api/api-overview/oauth-20-authentication.md) para obter mais informações. ## URLs base Epsilon Retail Media usa diferentes URLs base para ambientes de staging e produção. {% hint style="info" %} Para receber sua URL base de staging, entre em contato com Epsilon Retail Media. Assim que sua integração estiver em andamento, forneceremos as URLs base de produção. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.citrusad.com/retail-media-interface/integration/pt-br/data-api/api-overview.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.