CRM Bonus Tag Interactions API

openapi: 3.2.0
info:
  title: Oto Data Tag Interactions API
  description: 'A Data API do Oto permite que você faça cargas de dados

    de forma segura e confiável, utilizando padrões REST e corpos das mensagens em

    formato JSON.


    Os registros são inseridos na modalidade _upsert_, isto é, caso um registro

    com a mesma chave primária exista na base de dados, ele será integralmente

    substituído pelo registro enviado. Caso contrário, um novo registro será

    criado na base de dados.


    # Limites


    Dois limites são aplicados em todos os endpoints desta API: requisições por

    minuto e quantidade máxima de registros por requisição.


    ## Limite de requisições


    Para garantir a estabilidade e segurança da plataforma, esta API aceita um

    número máximo de **200** requisições por minuto por IP de origem. As

    requisições que excederem este limite terão suas respostas atrasadas para que

    se mantenha o ritmo estipulado, até que eventualmente podem ser barradas com a

    resposta `HTTP/1.1 429 Too many requests`.


    ## Limite de registros por requisição


    São aceitos até **10.000** registros por requisição. Caso a propriedade `data`

    contenha um número superior de entradas, a requisição será recusada com a

    resposta `HTTP/1.1 413 Payload Too Large`.'
  version: 1.3.5
  x-logo:
    url: https://pmweblabs.s3.amazonaws.com/assets/oto-logo.png
    href: https://suporte.otocrm.com.br/
    altText: Oto. Quem conhece, vende.
servers:
- url: https://data-api.otocrm.com.br
  description: Production
- url: https://data-api-hmg.otocrm.com.br
  description: Test
- url: http://localhost:8000
  description: Test
tags:
- name: Tag Interactions
paths:
  /v1/tag_interactions:
    post:
      summary: Post Tag Interaction
      description: Registra evento de interação com produto, categoria ou transação de compra.
      operationId: post_tag_interaction_v1_tag_interactions_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsInteractionsPostRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      tags:
      - Tag Interactions
components:
  schemas:
    TagType:
      type: string
      enum:
      - N
      - D
      - C
      - K
      - P
      - T
      title: TagType
    TagsInteraction:
      properties:
        event_ts:
          type: string
          format: date-time
          title: Event Ts
          description: Data e hora do evento
        user_id:
          type: integer
          minimum: 1.0
          title: User Id
          description: Identificador único do usuário
        session_id:
          type: integer
          minimum: 1.0
          title: Session Id
          description: Identificador único da sessão
        type:
          $ref: '#/components/schemas/TagType'
          description: "Tipo de evento: N = Navegação de categoria;\n        D = Página de detalhe de produto; C = Produto adicionado ao\n        carrinho; K = Checkout; P = Produtos comprados;\n        T = Transação de compra"
        id:
          type: string
          title: Id
          description: "Agrupador do produto (detalhe, carrinho e\n        checkout), código do pedido (transação) ou categoria (navegação)"
        sku:
          anyOf:
          - type: string
          - type: 'null'
          title: Sku
          description: Código de unidade de estocagem do produto (SKU)
        price:
          anyOf:
          - type: number
          - type: 'null'
          title: Price
          description: Preço unitário do item ou valor total do pedido
          default: 0
      type: object
      required:
      - event_ts
      - user_id
      - session_id
      - type
      - id
      title: TagsInteraction
    TagsInteractionsPostRequest:
      properties:
        data:
          items:
            $ref: '#/components/schemas/TagsInteraction'
          type: array
          title: Data
      type: object
      required:
      - data
      title: TagsInteractionsPostRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    SuccessResponse:
      properties:
        success:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Success
        requestId:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Requestid
      type: object
      title: SuccessResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      description: "Você deverá enviar sua chave privada\nno cabeçalho HTTP `Authorization`, com o padrão `Bearer <token>`. Exemplo:\n\n```\nGET / HTTP/1.1\nHost: data-api.otocrm.com.br\nAuthorization: Bearer abcdef123456\n```\n    "