Regresar al sistema
Fecha última actualización: 16 de diciembre de 2020

api/catalogos/almacen Listado de Alamacenes

Catálogo de los valores válidos para el parámetro de almacen

Endpoint
URL HTTP Method Authentication
https://s4.seq.gob.mx/api/catalogos/almacen GET false
Respuesta - Response

Devuelve un JSON con el listado de almacenes

api/catalogos/tipo_archivo Listado de Tipos de archivos

Catálogo de los valores válidos para el parámetro de tipo_archivo

Endpoint
URL HTTP Method Authentication
https://s4.seq.gob.mx/api/catalogos/tipo_archivo GET false
Respuesta - Response

Devuelve un JSON con el listado de tipos de archivos

api/file/exists Consulta si existe un tipo de archivo

Recibe ALMACEN + IDENTIFICADOR + TIPO_ARCHIVO y devuelve un arreglo con los nombres de los archivos contenidos ahí.
Si TIPO_ARCHIVO esta vacío se devuelve un arreglo con todos los tipos de archivos y el arreglo con los nombres de los archivos que contienen

Endpoint
URL HTTP Method Authentication
https://s4.seq.gob.mx/api/file/exists GET true
Parámetros para la solicitud - Request parameters
Parámetro Tipo Uso Descripción
UUID string requerido Identificador del sistema
almacen string requerido Nombre del almacen, del catálogo almacen. Si requieres un almacen envía correo al Departamento de Sistemas
identificador string requerido Identificador de la persona (por ejemplo CURP, CCT, RFC, etc.)
tipo_archivo string opcional Nombre del tipo de documento que se requiere saber si existe (del catálogo de tipo_archivo)
Respuesta - Response

Devuelve un JSON con el resultado de la búsqueda.

Ejemplo solicitud:
https://s4.seq.gob.mx/api/file/exists?api_token=MI-API-TOKEN&UUID=EL-UUID-DEL-SISTEMA-ORIGEN&almacen=alumnos&identificador=CIAJ940828HYNHVN04&tipo_archivo=pago
Ejemplo dato encontrado:
					

    {
        "status" : 200,
        "message" : "Consulta correcta",
        "resultado" : {
            "acta":["20200218035257_1.jpeg","20200218035751_2.jpeg","30.jpeg"],
            "pago":["20070723120217.png","20070723161426.png","20070723170720.png","200709160734lio.png","20080415002735.png"]
        }
    }
Ejemplo no encontrado:
					

    {
        "status" : 200,
        "message" : "Consulta correcta",
        "resultado" : []
    }

api/file/file-exists Verifica si existe un archivo dado un path completo

Endpoint
URL HTTP Method Authentication
https://s4.seq.gob.mx/api/file/file-exists GET true
Parámetros para la solicitud - Request parameters
Parámetro Tipo Uso Descripción
UUID string requerido Identificador del sistema
path string requerido Ruta completa donde se encuentra el archivo (ALMACEN / IDENTIFICADOR / TIPO_ARCHIVO / NOMBRE_ARCHIVO)
Respuesta - Response

Devuelve un JSON con información del resultado.

  • Si el archivo existe devuelve: en el atributo "resultado" un atributo "path" con el mismo valor del path enviado
  • Si no existe devuelve el atributo "resultado" vacío

Ejemplo cuando el archivo existe:
					

    {
        "status" : 200,
        "message" : "El archivo existe",
        "resultado" : {"path":"beneficiarios/12345/ingreso/201216141345escudo.png"}
    }
Ejemplo respuesta archivo no se encuentra:

El atributo "resultado" esta vacío []. En el atributo "message" está la descripción del error. 

					

    {
        "status" : 200,
        "message":"Archivo no encontrado",
        "resultado":[]
    }

api/file/upload subir un archivo

Endpoint
URL HTTP Method Authentication
https://s4.seq.gob.mx/api/file/upload POST true
Parámetros para la solicitud - Request parameters
Parámetro Tipo Uso Descripción
UUID string requerido Identificador del sistema origen
almacen string requerido Nombre del almacen, del catálogo almacen. Si requieres un almacen envía correo al Departamento de Sistemas
identificador string requerido Identificador de la persona (por ejemplo CURP, CCT, RFC, etc.)
tipo_archivo string requerido Nombre del tipo de archivo que se carga (del catálogo de tipo_archivo)
file file requerido Archivo binario que se quiere subir
sin_timestamp string opcional Enviar "true" o "1" si requieres que el archivo no lleve estampa de tiempo al inicio (indistintamente se remueven caracteres no válidos para el nombre de un archivo en linux)
Respuesta - Response

Devuelve un JSON con información del resultado de carga. En el atributo "resultado" existe atributo "path" con la ruta completa donde se guardó el archivo.
"path" está compuesto por ALMACEN / IDENTIFICADOR / TIPO_ARCHIVO / NOMBRE_ARCHIVO

Ejemplo solicitud (desde HTML):
					

    <form id='s4_form' method='post'
action='https://s4.seq.gob.mx/api/file/upload?api_token=TU-API-TOKEN&UUID=EL-UUID-DEL-SISTEMA-ORIGEN'
enctype='multipart/form-data'>
    <input name='file' type='file' id='s4_file' multiple='multiple' required/>
    <input name='almacen' type='hidden' id='s4_almacen' value='alumnos' required/>
    <input name='identificador' type='hidden' id='s4_identificador' value='ZAMG831110MTCPND07' required/>
    <input name='tipo_archivo' type='hidden' id='s4_tipo_archivo' value='acta' required/>
    <input name='sin_timestamp' type='hidden' id='s4_sin_timestamp' value='true'/>
    <p><input type='submit' value='Subir'/></p>
</form>
Ejemplo de carga correcta:
					

    {
        "status" : 200,
        "message" : "Consulta correcta",
        "resultado" : {"path":"alumnos/CIAJ940828HYNHVN04/pago/200724143114mideposito.png"}
    }
Ejemplo respuesta de carga incorrecta:

El atributo "resultado" esta vacío []. En el atributo "message" está la descripción del error. 

					

    {
        "status" : 200,
        "message":"El campo almacen es obligatorio. El campo identificador es obligatorio. El campo tipo archivo es obligatorio.",
        "resultado":[]
    }

api/file/download Descarga archivo

Endpoint
URL HTTP Method Authentication
https://s4.seq.gob.mx/api/file/download GET true
Parámetros para la solicitud - Request parameters
Parámetro Tipo Uso Descripción
UUID string requerido Identificador del sistema
file string requerido Ruta completa donde se encuentra el archivo (ALMACEN / IDENTIFICADOR / TIPO_ARCHIVO / NOMBRE_ARCHIVO)

Respuesta - Response

Devuelve el contenido binario del archivo o respuesta 404 no encontrado

Ejemplo solicitud dependiendo del tipo de archivo es la forma de solicitar:
					

                        IMAGEN
   
    <img src='https://s4.seq.gob.mx/api/file/download?api_token=MI-API-TOKEN&UUID=EL-UUID-DEL-SISTEMA-ORIGEN&file=alumnos/ZAMG831110MTCPND07/acta/mi-acta.jpg'>
    
                        O PDF
   
    <embed width='500' height='500' src='https://s4.seq.gob.mx/api/file/download?api_token=MI-API-TOKEN&UUID=EL-UUID-DEL-SISTEMA-ORIGEN&file=alumnos/ZAMG831110MTCPND07/acta/mi-acta.pdf' type='application/pdf'></embed>

api/file/delete-file borrar un archivo

Endpoint
URL HTTP Method Authentication
https://s4.seq.gob.mx/api/file/delete-file DELETE true
Parámetros para la solicitud - Request parameters
Parámetro Tipo Uso Descripción
UUID string requerido Identificador del sistema origen
almacen string requerido Nombre del almacen, del catálogo almacen. Si requieres un almacen envía correo al Departamento de Sistemas
identificador string requerido Identificador de la persona (por ejemplo CURP, CCT, RFC, etc.)
tipo_archivo string requerido Nombre del tipo de documento donde esta almacenado (del catálogo de tipo_archivo)
filename file requerido Nombre del archivo a borrar
Respuesta - Response

Devuelve un JSON con información sobre la operación.

Ejemplo de respuesta en llamado correcto:
					

    {
        "status" : 200,
        "message" : "Archivo borrado correctamente",
        "resultado" : []
    }
Ejemplo cuando el archivo a borrar no existe:
					

    {
        "status" : 404,
        "message":"No existe el archivo que intentas eliminar",
        "resultado":[]
    }