openapi: 3.0.3
info:
  title: API vigencia de documentos de identidad
  contact:
    name: Impish API
    url: https://impishapi.com
    email: contacto@impish.top
  description: >
    Servicio para verificar la validez de documentos de identidad chilenos (cédula de identidad y pasaporte)
  version: 1.0.0
servers:
  - url: https://regcivil.impish.top
    description: Servidor principal

tags:
  - name: main

components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-api-key
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: boolean
        desc:
          type: string
        error_code:
          type: string
      required:
        - error
        - desc
        - error_code
    BalanceResponse:
      type: object
      properties:
        error:
          type: boolean
        balance:
          type: integer
          description: Saldo disponible en CLP$
      required:
        - error
        - balance
    QueryRequest:
      type: object
      properties:
        doc_num:
          type: string
          example: "12345678"
        run:
          type: string
          example: "98765432-K"
        doc_type:
          type: string
          enum: [CEDULA, PASAPORTE]
      required:
        - doc_num
        - run
        - doc_type
    QueryResponse:
      type: object
      properties:
        error:
          type: boolean
        state:
          type: string
          enum: [VALID, NOT_VALID, NO_MATCH]
        state_spa:
          type: string
      required:
        - error
        - state
        - state_spa

paths:
  /balance:
    get:
      operationId: getBalance
      tags:
        - main
      summary: Obtener saldo del usuario
      description: Devuelve el saldo disponible en CLP$ del usuario autenticado.
      security:
        - ApiKeyAuth: []
        - {}
      responses:
        '200':
          description: Saldo obtenido correctamente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceResponse'
        '401':
          description: No se proporcionó clave de API o es inválida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: No se encontró saldo disponible
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Clave API no existe
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          

  /query:
    post:
      operationId: queryDocument
      tags: 
        - main
      summary: Consultar vigencia de documento
      description: Devuelve el estado de vigencia de un documento de identidad chileno.
      security:
        - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/QueryRequest'
      responses:
        '200':
          description: Estado del documento
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
        '400':
          description: Parámetros inválidos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: No se proporcionó clave de API o es inválida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'