Zoop Events API

swagger: '2.0'
x-api-id: 'notificações-e-eventos'
host: api.zoop.ws
info: 
  title: Notificações e Eventos
  version: "1.1"

securityDefinitions:
  basicAuth:
    type: basic
security:
  - basicAuth: []

schemes:
  - https

tags:
  - name: 'Notificações'
    description: Notifiações sobre eventos
  - name: 'Eventos'
    description: Notifiações e eventos de alteração de estado

paths:
  '/v1/marketplaces/{marketplace_id}/webhooks':
    parameters:
      - name: marketplace_id
        in: path
        description: identificador do marketplace
        required: true
        type: string
    post:
      tags:
        - 'Webhook'
      summary: 'Cria webhook por marketplace'
      description: ''
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Webhook criado com sucesso
        '400':
          description: Requisição inválida
        '404':
          description: Marketplace não encontrado
    get:
      tags:
        - 'Webhook'
      summary: 'Listar webhooks por marketplace'
      description: ''
      produces:
        - application/json
      responses:
        '200':
          description: Webhook listado com sucesso
        '404':
          description: Marketplace não encontrado

  '/v1/marketplaces/{marketplace_id}/webhooks/{webhook_id}':
    parameters:
      - name: marketplace_id
        in: path
        description: identificador do marketplace
        required: true
        type: string
      - name: webhook_id
        in: path
        description: identificador do webhook
        required: true
        type: string
    get:
      tags:
        - 'Webhook'
      summary: 'Recuperar detalhes de webhook'
      description: ''
      produces:
        - application/json
      responses:
        '200':
          description: Webhook recuperado com sucesso
        '404':
          description: Marketplace/Webhook não encontrado
    delete:
      tags:
        - 'Webhook'
      summary: 'Remover webhook'
      description: ''
      produces:
        - application/json
      responses:
        '200':
          description: Webhook removido com sucesso
        '404':
          description: Marketplace/Webhook não encontrado

  '/v1/marketplaces/{marketplace_id}/events/{event_id}':
    parameters:
      - name: marketplace_id
        in: path
        description: identificador do marketplace
        required: true
        type: string
      - name: event_id
        in: path
        description: identificador do evento
        required: true
        type: string
    get:
      tags:
        - 'Evento'
      summary: 'Recuperar detalhes de evento pelo identificador'
      description: ''
      produces:
        - application/json
      responses:
        '200':
          description: Evento recuperado com sucesso
        '404':
          description: Marketplace/Evento não encontrado

  '/v1/marketplaces/{marketplace_id}/events':
    parameters:
      - name: marketplace_id
        in: path
        description: identificador do marketplace
        required: true
        type: string
    get:
      tags:
        - 'Evento'
      summary: 'Listar eventos por marketplace'
      description: ''
      produces:
        - application/json
      responses:
        '200':
          description: Evento listado com sucesso
        '404':
          description: Marketplace não encontrado

parameters:
  limitParam:
    name: limit
    in: query
    description: Limita o número de objetos retornados, podendo ser entre 1 e 100
    required: false
    type: number
    format: int32
    default: 20
  sortParam:
    name: sort
    in: query
    description: Determinar como ordenar a lista em relação a data de criação do objeto
    required: false
    type: string
    enum: 
      - time-descending
      - time-ascending
    default: time-descending
  offsetParam:
    name: offset
    in: query
    description: Determina o ponto de inicio dos registros retornados
    required: false
    type: number
    format: int32
    default: 0
  dateRangeParam:
    name: date_range
    in: query
    description: Filtro na lista base de objetos pela data de criação. O valor pode ser uma string com um horário em UTC timestamp, ou pode ser uma lista com os parametros abaixo
    required: false
    type: number
  dateRangeGTParam:  
    name: date_range[gt]
    in: query
    description: Retorna valores onde a data maior que o timestamp informado
    required: false
    type: number
  dateRangeGTEParam:
    name: date_range[gte]
    in: query
    description: Retorna valores onde a data for maior ou igual que o timestamp informado
    required: false
    type: number
  dateRangeLTParam:
    name: date_range[lt]
    in: query
    description: Retorna valores onde a data for menor que o timestamp informado
    required: false
    type: number
  dateRangeLTEParam:
    name: date_range[lte]
    in: query
    description: Retorna valores onde a data for menor ou igual que o timestamp informado
    required: false
    type: number