openapi: 3.0.1
info:
  license:
    name: Khipu Open Data API
    url: https://khipu.com
  title: Mercado Público
  description: ''
  version: v1.0
servers:
  - url: https://api.khipu.com
    description: Production
security:
  - JWT: []
  - Api-Key: []
paths:
  /v1/cl/services/mercadopublico.cl/tender-search:
    post:
      summary: Tenders
      description: >-
        Este método retorna licitaciones públicas desde el sistema de compras
        del gobierno chileno, usando el sitio web de **Mercado Público**.


        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: TenderSearch
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenderSearchRequest'
        required: true
      responses:
        '200':
          description: Operación exitosa. Retorna un objeto JSON con los datos solicitados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenderSearchResponseSyncOk'
        '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/TenderSearchResponseAsync'
        '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:
    TenderSearchRequest:
      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:
            TenderSearch:
              type: string
              description: >-
                Palabra clave para buscar en el título o descripción de la
                licitación.
              example: antivirus
            Type:
              type: string
              description: Tipo de procedimiento de licitación.
              example: Licitación Pública
            Region:
              type: string
              description: Región geográfica donde se emite la licitación.
              example: Región Metropolitana
            Status:
              type: string
              description: Estado de la licitación (por ejemplo, Publicada, Cerrada).
              example: Publicada
            DateStart:
              type: string
              description: Fecha de inicio para la publicación de licitaciones.
              example: '2025-06-01'
            DateEnd:
              type: string
              description: Fecha de término para la publicación de licitaciones.
              example: '2025-06-30'
          required:
            - TenderSearch
          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
    TenderSearchResponseSyncOk:
      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
          description: Contenedor de licitaciones.
          required:
            - Tender
          properties:
            Tender:
              type: array
              description: Lista de licitaciones publicadas.
              items:
                type: object
                properties:
                  TenderIdentifier:
                    type: string
                    description: Identificador único de la licitación.
                    example: 956-49-LE25
                  TenderTitle:
                    type: string
                    description: Título de la licitación.
                    example: Antivirus
                  TenderDescription:
                    type: string
                    description: Descripción de la licitación.
                    example: Renovación de licencias por 12 meses.
                  Amount:
                    type: string
                    description: Monto asignado a la licitación.
                    example: 8.400.000
                  PublishDate:
                    type: string
                    description: Fecha en que se publicó la licitación.
                    example: 22/05/2025
                  ClosingDate:
                    type: string
                    description: Fecha de cierre de la licitación.
                    example: 03/06/2025
                  BuyerEntity:
                    type: string
                    description: Nombre de la entidad compradora.
                    example: SERVICIO DE SALUD VALPARAÍSO SAN ANTONIO
                  BuyerEntityFull:
                    type: string
                    description: Nombre completo o descripción de la entidad compradora.
                    example: SERVICIO DE SALUD VALPARAÍSO SAN ANTONIO
                  PurchasesLast12Months:
                    type: integer
                    description: >-
                      Número de compras realizadas por la entidad en los últimos
                      12 meses.
                    example: 719
                  LatePaymentComplaints:
                    type: integer
                    description: Cantidad de reclamos por pagos atrasados.
                    example: 284
          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
    TenderSearchResponseAsync:
      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
