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

# Criar programa de afiliados

> Cria um programa de afiliados para um produto do anunciante. Cada produto pode ter no máximo um programa.



## OpenAPI

````yaml /api-reference/openapi.json post /api/affiliate/programs
openapi: 3.0.3
info:
  title: Alpa Gateway API
  version: 2.30.0
  description: >-
    Documentação completa da API pública do Alpa Gateway (v2.23.0). Todas as
    rotas requerem autenticação via API Key, exceto validação de cupom, checkout
    público e checkout de assinaturas. Novidades em 2.23.0: sistema de
    assinaturas recorrentes com planos, retry automático e métricas MRR/churn;
    cart abandonment para recuperação de vendas.
  contact:
    email: suporte@usealpa.com
  license:
    name: MIT
servers:
  - url: https://alpa-sistema-api.onrender.com
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: Transações
    description: Gerenciamento de transações de pagamento
  - name: Links de Pagamento
    description: Gerenciamento de links de pagamento
  - name: Produtos
    description: Gerenciamento de produtos do catálogo
  - name: Cupons
    description: Gerenciamento de cupons de desconto
  - name: Webhooks
    description: Gerenciamento de webhooks e assinaturas
  - name: Saldo
    description: Consulta de saldo e movimentações
  - name: Clientes
    description: Gerenciamento de clientes
  - name: Afiliados
    description: Marketplace de afiliados, links rastreáveis e comissões automáticas
  - name: Assinaturas
    description: Planos de assinatura recorrente, checkout público e métricas MRR/churn
  - name: Saques
    description: Solicitações de saque, saldo disponível e métodos de retirada
  - name: Antecipações
    description: Antecipação de recebíveis de transações de cartão parceladas
  - name: Indicações
    description: >-
      Programa de indicações — código de convite, estatísticas e histórico de
      recompensas
paths:
  /api/affiliate/programs:
    post:
      tags:
        - Afiliados
      summary: Criar programa de afiliados
      description: >-
        Cria um programa de afiliados para um produto do anunciante. Cada
        produto pode ter no máximo um programa.
      operationId: createAffiliateProgram
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - productId
                - commissionType
                - commissionValue
              properties:
                productId:
                  type: string
                  format: uuid
                  description: ID do produto
                commissionType:
                  type: string
                  enum:
                    - PERCENTAGE
                    - FIXED
                commissionValue:
                  type: integer
                  description: >-
                    Para PERCENTAGE: % × 100 (ex: 1000 = 10%). Para FIXED:
                    centavos.
                  minimum: 1
                cookieDays:
                  type: integer
                  default: 30
                  minimum: 1
                  maximum: 365
                isActive:
                  type: boolean
                  default: true
                description:
                  type: string
                  maxLength: 2000
                rules:
                  type: string
                  maxLength: 5000
                affiliatePage:
                  type: string
                  format: uri
                salesPage:
                  type: string
                  format: uri
                extendedCommission:
                  type: boolean
                  default: false
      responses:
        '201':
          description: Programa criado com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/AffiliateProgram'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - apiKeyAuth: []
components:
  schemas:
    AffiliateProgram:
      type: object
      properties:
        id:
          type: string
          format: uuid
        productId:
          type: string
          format: uuid
        commissionType:
          type: string
          enum:
            - PERCENTAGE
            - FIXED
        commissionValue:
          type: integer
          description: 'Para PERCENTAGE: % × 100. Para FIXED: centavos.'
        cookieDays:
          type: integer
        isActive:
          type: boolean
        description:
          type: string
          nullable: true
        rules:
          type: string
          nullable: true
        affiliatePage:
          type: string
          nullable: true
        salesPage:
          type: string
          nullable: true
        extendedCommission:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        product:
          type: object
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
            price:
              type: integer
            imageUrl:
              type: string
              nullable: true
            description:
              type: string
              nullable: true
        user:
          type: object
          properties:
            name:
              type: string
        _count:
          type: object
          properties:
            links:
              type: integer
  responses:
    BadRequest:
      description: Requisição inválida
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              timestamp:
                type: string
                format: date-time
              path:
                type: string
              errors:
                type: array
                items:
                  type: object
    Unauthorized:
      description: Não autorizado - API Key inválida ou ausente
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
    NotFound:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: API-Key
      description: >-
        Chave de API obtida através do endpoint /api/credentials. Também aceita
        formato Bearer Token: Authorization: Bearer <api_key>

````