> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Adicionar pixel de rastreamento > Cadastra um pixel (Meta, Google Ads, TikTok, GTM e afins) para disparar eventos de conversão a partir do checkout do vendedor, ligado a um produto e, opcionalmente, a um checkout específico. Reenviar o mesmo código para o mesmo provedor atualiza a configuração em vez de duplicar o pixel. Pegue o `productId` em `GET /v1/products` e o `pixelServiceTypeId` em `GET /v1/pixel-providers` — o `1` do exemplo é o Meta Ads. Responde 404 quando o produto ou o checkout pertence a outra empresa. ## OpenAPI ````yaml /openapi.yaml post /v1/pixels openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/pixels: post: tags: - Checkout summary: Adicionar pixel de rastreamento description: >- Cadastra um pixel (Meta, Google Ads, TikTok, GTM e afins) para disparar eventos de conversão a partir do checkout do vendedor, ligado a um produto e, opcionalmente, a um checkout específico. Reenviar o mesmo código para o mesmo provedor atualiza a configuração em vez de duplicar o pixel. Pegue o `productId` em `GET /v1/products` e o `pixelServiceTypeId` em `GET /v1/pixel-providers` — o `1` do exemplo é o Meta Ads. Responde 404 quando o produto ou o checkout pertence a outra empresa. operationId: createPixel requestBody: required: true content: application/json: schema: type: object properties: productId: type: string pattern: ^[cC][^\s-]{8,}$ description: >- Produto em que o pixel vai disparar, de `GET /v1/products`. Um pixel nasce sempre ligado a um produto. checkoutId: type: string pattern: ^[cC][^\s-]{8,}$ description: >- Liga o pixel também a um checkout `v2`; aquele checkout passa a disparar só os pixels dele. pixelServiceTypeId: type: integer exclusiveMinimum: true minimum: 0 description: Provedor do pixel — ver `GET /v1/pixel-providers`. pixelCode: type: string minLength: 1 maxLength: 4096 description: >- Identificador do pixel na plataforma de anúncios, ou o trecho de código copiado dela. name: type: string minLength: 2 maxLength: 255 description: Apelido para o vendedor reconhecer o pixel. valueType: type: string enum: - total_order_and_feess - total_products_and_freight default: total_order_and_feess description: Qual valor vai na conversão. isMarkPix: type: boolean default: false description: Dispara a conversão já na geração do Pix. status: type: boolean default: true description: Nasce disparando; envie `false` para cadastrar pausado. conversionLabel: type: string nullable: true description: Rótulo de conversão do Google Ads. conversionValue: type: integer nullable: true description: Valor fixo de conversão em centavos. triggerOnCheckout: type: boolean default: false description: Dispara ao abrir o checkout. triggerOnBeginCheckout: type: boolean default: false description: Dispara ao começar o preenchimento. capiAccessToken: type: string nullable: true description: >- Token da API de conversões do provedor. Guardado cifrado e nunca devolvido na leitura. testEventCode: type: string nullable: true description: Código de evento de teste do provedor. required: - productId - pixelServiceTypeId - pixelCode additionalProperties: false example: productId: clx8a2h4k0001qz0a1b2c3d4e pixelServiceTypeId: 1 pixelCode: '1284937561029384' name: Meta — Curso de Tráfego Pago triggerOnCheckout: true capiAccessToken: EAAG9ZC0exemploDeTokenDeConversoes testEventCode: TEST48291 responses: '201': description: Pixel cadastrado. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: id: type: integer description: Identificador do pixel. name: type: string nullable: true description: Apelido do pixel escolhido pelo vendedor. pixelCode: type: string description: Identificador do pixel na plataforma de anúncios. provider: type: object properties: id: type: string description: Identificador do provedor de pixel. name: type: string description: Nome do provedor exibido no painel. type: type: string description: >- Código curto do provedor usado pelo disparo (`meta`, `gads`, `gtm`...). slug: type: string description: Identificador textual estável do provedor. required: - id - name - type - slug additionalProperties: false description: Plataforma de anúncios que recebe os eventos. status: type: boolean description: '`false` pausa o disparo sem apagar a configuração.' valueType: type: string enum: - total_order_and_feess - total_products_and_freight description: >- Qual valor é enviado na conversão: o total do pedido com taxas ou o dos produtos com frete. isMarkPix: type: boolean description: >- Dispara a conversão já na geração do Pix, antes da confirmação. conversionLabel: type: string nullable: true description: Rótulo de conversão do Google Ads. conversionValue: type: integer nullable: true description: Valor fixo de conversão em centavos, quando usado. triggerOnCheckout: type: boolean description: Dispara o evento quando o comprador abre o checkout. triggerOnBeginCheckout: type: boolean description: >- Dispara o evento quando o comprador começa a preencher. hasCapiToken: type: boolean description: >- Se há um token de API de conversões guardado. O token nunca é devolvido. testEventCode: type: string nullable: true description: >- Código de evento de teste do provedor, quando configurado. productIds: type: array items: type: string description: Produtos em que este pixel dispara. createdAt: type: string format: date-time description: Momento de criação do pixel. updatedAt: type: string format: date-time description: Momento da última alteração. required: - id - name - pixelCode - provider - status - valueType - isMarkPix - conversionLabel - conversionValue - triggerOnCheckout - triggerOnBeginCheckout - hasCapiToken - testEventCode - productIds - createdAt - updatedAt additionalProperties: false required: - success - data additionalProperties: false description: Pixel cadastrado. example: success: true data: id: 3187 name: Meta — Curso de Tráfego Pago pixelCode: '1284937561029384' provider: id: '1' name: Meta Ads type: meta slug: meta-ads status: true valueType: total_order_and_feess isMarkPix: false conversionLabel: null conversionValue: null triggerOnCheckout: true triggerOnBeginCheckout: false hasCapiToken: true testEventCode: TEST48291 productIds: - clx8a2h4k0001qz0a1b2c3d4e createdAt: '2026-08-19T14:02:00.000Z' updatedAt: '2026-09-10T09:31:00.000Z' '400': description: A requisição está bem formada, mas uma regra de negócio a recusou. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- A requisição está bem formada, mas uma regra de negócio a recusou. example: success: false message: >- Checkouts da geração v1 não vinculam pixels próprios — o pixel do produto já vale para eles. '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '404': description: O recurso não existe, foi excluído ou pertence a outra empresa. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- O recurso não existe, foi excluído ou pertence a outra empresa. example: success: false message: Produto não encontrado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````