openapi: 3.0.1
info:
  license:
    name: Khipu Open Data API
    url: https://khipu.com
  title: Zonaprop
  description: ''
  version: v1.0
servers:
  - url: https://api.khipu.com
    description: Production
security:
  - JWT: []
  - Api-Key: []
paths:
  /v1/ar/services/zonaprop.com.ar/data/purchase:
    post:
      summary: Purchase Data
      description: >-
        Este método se conecta a la cuenta especificada por el usuario en
        **Zonaprop** y retorna los datos de compra de las propiedades que
        cumplan con los parámetros de entrada (también conocido como "Extraer
        datos de compra del portal").


        El uso del campo `CallbackUrl` desencadenará un proceso asíncrono y los
        datos resultantes se enviarán más tarde al webhook especificado. Esta es
        la forma preferida de interactuar con nuestros servicios, ya que asegura
        que se harán todos los esfuerzos para extraer los datos y cumplir  con
        su solicitud dentro de un plazo razonable. Si desea la respuesta de
        inmediato, omita el campo `CallbackUrl` pero tenga en cuenta que puede
        provocar tiempos de espera dependiendo del tamaño del resultado de los
        datos y las condiciones de la red.
      operationId: DataPurchase
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataPurchaseRequest'
        required: true
      responses:
        '200':
          description: Operación exitosa. Retorna un objeto JSON con los datos solicitados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPurchaseResponseSyncOk'
        '202':
          description: >-
            Operación exitosa. Retorna un mensaje JSON informando el resultado
            de la operación solicitada. La respuesta completa, con el mismo
            esquema que la versión síncrona, se enviará al URL de callback
            proporcionado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPurchaseResponseAsync'
        '400':
          description: Solicitud incorrecta
        '401':
          description: No autorizado - Credenciales inválidas o faltantes
        '404':
          description: No encontrado - Recurso no disponible
        '500':
          description: Error en el servicio remoto :(
components:
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
    Api-Key:
      type: apiKey
      in: header
      name: x-api-key
  schemas:
    DataPurchaseRequest:
      additionalProperties: false
      description: Objeto para realizar una solicitud al servicio OpenData.
      properties:
        RequestData:
          additionalProperties: false
          description: >-
            Información necesaria para conectarse a la cuenta del usuario en el
            sitio web y extraer datos. Los campos obligatorios indican los
            valores necesarios para identificar la cuenta deseada.
          properties:
            LocationFeatures:
              description: Ubicación geográfica donde está situada la propiedad del anuncio
              example: Godoy Cruz, Mendoza
              type: string
            PropertyType:
              description: Tipo de propiedad a buscar
              example: Casas
              type: string
            PropertyOperationType:
              description: Tipo de operación de la propiedad
              example: Alquiler
              type: string
          required:
            - LocationFeatures
            - PropertyType
            - PropertyOperationType
          type: object
        CallbackUrl:
          description: URL para enviar el mensaje de respuesta utilizando un método POST.
          example: https://my-api.my-business.com/api/open-data-response
          type: string
          maxLength: 255
      required:
        - RequestData
      type: object
    DataPurchaseResponseSyncOk:
      additionalProperties: false
      description: >-
        Objeto con la respuesta desde el servicio OpenData, en modo Sincrónico,
        cuando `Status` es "OK"
      properties:
        OperationId:
          description: Identificador único de la operación.
          example: 6baf6c19-e485-463b-ae24-a821b025c8a4
          type: string
          maxLength: 36
        Status:
          description: >-
            Estado de la operación. `OK` significa que el servicio se ha
            ejecutado correctamente aunque no devuelva datos. `ERROR` indica que
            ha ocurrido algo que ha impedido la finalización con éxito del
            proceso.
          example: OK
          type: string
          enum:
            - OK
            - ERROR
        Data:
          additionalProperties: false
          type: object
          required:
            - PurchaseData
          properties:
            PurchaseData:
              type: array
              description: Contenedor para los datos de los anuncios de propiedades.
              example: ''
              items:
                type: object
                required:
                  - Ambients
                  - Bathrooms
                  - Bedrooms
                  - Date
                  - Garages
                  - Location
                  - Price
                  - TotalArea
                  - DataId
                properties:
                  Date:
                    type: string
                    description: >-
                      La fecha correspondiente al momento de ejecución de la
                      operación.
                    example: 2024-11-13T10:30:57-0300
                  Location:
                    type: string
                    description: >-
                      Provincia y/o departamento donde está ubicada la
                      propiedad.
                    example: '2'
                  Bedrooms:
                    type: string
                    description: Número de habitaciones de la propiedad.
                    example: '2'
                  Bathrooms:
                    type: string
                    description: Número de baños de la propiedad.
                    example: '2'
                  Ambients:
                    type: string
                    description: Número de ambientes de la propiedad.
                    example: '2'
                  Garages:
                    type: string
                    description: Número de cocheras de la propiedad.
                    example: '2'
                  TotalArea:
                    type: string
                    description: Área total de la propiedad.
                    example: '220'
                  CoveredArea:
                    type: string
                    description: Área cubierta de la propiedad
                    example: '100'
                  Price:
                    type: object
                    required:
                      - Amount
                      - Currency
                    description: >-
                      El monto total asociado al anuncio correspondiente al
                      valor y divisa.
                    example: ''
                    properties:
                      Amount:
                        type: number
                        description: Precio de la propiedad.
                        example: 99
                      Currency:
                        type: string
                        description: >-
                          Tipo de divisa que opera el anuncio, debe cumplir con
                          el estándar ISO 4217.
                        example: ARS | USD
                  MapUrl:
                    type: string
                    description: Url de google maps de la propiedad
                    example: '2'
                  DataId:
                    type: string
                    description: Código de Zonaprop de la propiedad
                    example: '2'
          nullable: true
        AdditionalInformation:
          description: >-
            Este campo puede utilizarse para mostrar información relevante
            específica de la respuesta, por ejemplo indicando que el campo
            `Data` está incompleto.
          example: null
          type: string
          nullable: true
        Error:
          description: >-
            Objeto con los detalles del error, utilizado cuando `Status=ERROR`.
            Si `Status=OK` este campo será nulo. Puede leer una explicación
            completa de este objeto visitando [este
            enlace](https://docs.khipu.com/portal/en/errors/)
          example: null
          properties:
            Code:
              description: Código interno del sistema que identifica el error.
              example: E201
              type: string
            Type:
              description: >-
                Indica cómo tratar este código de error específico, en función
                del tipo de error.
              example: RETRY_IMMEDIATELY
              type: string
              enum:
                - RETRY_IMMEDIATELY
                - DO_NOT_RETRY
                - WAIT_4_HOURS_BEFORE_RETRY
                - RETRY_AFTER_NOTIFICATION
            Description:
              description: Descripción asociada al código de error.
              example: >-
                El servicio destino utilizado para la extracción de datos no se
                encuentra disponible.
              type: string
          required: []
          type: object
          nullable: true
        LifeSpan:
          description: '`null` en peticiones sincrónicas.'
          example: null
          type: string
          nullable: true
      required:
        - OperationId
        - Status
        - Data
        - AdditionalInformation
        - Error
        - LifeSpan
      type: object
    DataPurchaseResponseAsync:
      type: object
      description: Objeto con la respuesta del servicio OpenData, en modo asíncrono.
      required:
        - OperationId
        - Status
        - Data
        - AdditionalInformation
        - Error
        - LifeSpan
      properties:
        OperationId:
          maxLength: 36
          type: string
          description: Identificador único de la operación.
          example: 6baf6c19-e485-463b-ae24-a821b025c8a4
        Status:
          type: string
          description: >-
            Estado de la operación. Al realizar solicitudes asíncronas, siempre
            devolverá `OK`.
          example: OK
        Data:
          type: object
          description: '`null` en solicitudes asíncronas.'
          example: null
        AdditionalInformation:
          type: string
          description: >-
            Mensaje de la operación, puede usarse para mostrar información
            adicional.
          example: Data will be sent to the callback URL.
        Error:
          type: object
          description: '`null` en solicitudes asíncronas.'
          example: null
        LifeSpan:
          type: string
          format: date-time
          description: >-
            Fecha máxima estimada de entrega para solicitudes asíncronas, en
            formato de fecha y hora ISO 8601, zona horaria UTC.
          example: 2017-07-22T00:00:00-0400
