API Search

    La siguiente API permite hacer búsquedas simples dentro de la base de datos.

    Nota: Se devuelven solo los primeros 50 resultados de búsqueda.
    Nota 2: En caso de querer buscar certificados por uuid debe utilizar API Verify.

    Endpoint

    • URL: api/v2/search.php
    • Necesita iniciar sesión: Si
    • Métodos: GET

    Argumentos

    • token str: Token de utilización de la API. (Obtener aquí)
    • where enum: Sobre que desea ejecutar su búsqueda, valores posibles:
      • user → Búsqueda de usuarios/alumnos
      • course → Búsqueda sobre cursos
    • what enum: Donde buscar, valores posibles:
    • args str: Consulta de búsqueda. La consulta será case insensitive y pueden usarse los comodínes de SQL _ y %.
    • from date: Fecha inicial (en formato: ddMMyyyy-HH:mm)
    • upto date: Fecha final (en formato: ddMMyyyy-HH:mm)

    Nota: Algunas equivalencias de la fechas son:

    • C para strformat → %d%m%Y-%H%M
    • MySQL para STR_TO_DATE → %d%m%Y-%H%i
    • PHP para date_format → dmY-Hi

    Devuelve

    • 503: Sistema en matenimiento (application/json)
    • 405: Método inválido (application/json)
    • 404: Curso no encontrado (application/json)
    • 400: Argumentos inválidos (application/json)
    • 200: Resultado de búsqueda (application/json)

    Ejemplo

    Búsqueda de curso

    Request

    • Request: GET api/v2/user.php
    • Arguments:
      • token → 56bc8.....673b4
      • where → course
      • what → name
      • args → %g_nero%

    Response

    • Headers: Content Type: application/json
    • Body:
      {
    "count": 2,
    "result": [
        2,
        24
    ],
    "limit": false,
    "query": {
        "what": "name",
        "where": "course",
        "args": "%g_nero%"
    }
}

    Búsqueda de usuario

    Request

    • Request: GET api/v2/user.php
    • Arguments:
      • token → 56bc8.....673b4
      • where → user
      • what → name
      • args → %fede%
      • from → 30012019-0051

    Response

    • Headers: Content Type: application/json
    • Body:
      {
    "count": 10,
    "result": [
        2906,
        3136,
        3457,
        4056,
        4317,
        4960,
        5007,
        5574,
        6457,
        6591
    ],
    "limit": false,
    "query": {
        "what": "name",
        "where": "user",
        "args": "%fede%",
        "from": {
            "year": 2019,
            "month": 1,
            "day": 30,
            "hour": 0,
            "minute": 51
        }
    }
}
    publicado