{"info":{"_postman_id":"027fa4c0-a32a-4b83-a2a6-1f6f9fe11f70","name":"api-storage","description":"

La API de Ypw Storage es una API desarrollada por Ypw que permite guardar y manejar archivos e imágenes en un sistema de almacenamiento en línea. Esta API proporciona una variedad de rutas para realizar diferentes acciones, tales como:

/api/v1/manager/mkdir: Crea un directorio en el sistema de almacenamiento. Los parámetros de entrada incluyen \"path\" (ruta y nombre de la carpeta a crear) y \"appConnect\" y \"keyUser\" (opcionales, utilizados para autenticar la conexión a la API).
\n
/api/v1/manager/rm: Elimina un archivo o directorio completo. Los parámetros de entrada incluyen \"path\" (ruta del archivo o directorio a eliminar) y \"appConnect\" y \"keyUser\" (opcionales, utilizados para autenticar la conexión a la API).
\n
/api/v1/manager/ls: Lista los archivos y directorios en una ruta específica. Los parámetros de entrada incluyen \"path\" (ruta del directorio a listar) y \"appConnect\" y \"keyUser\" (opcionales, utilizados para autenticar la conexión a la API).
\n
/api/v1/manager/mv: Mueve o renombra un archivo o directorio. Los parámetros de entrada incluyen \"src\" (ruta actual del archivo o directorio) y \"dest\" (ruta de destino o nuevo nombre del archivo o directorio) y \"appConnect\" y \"keyUser\" (opcionales, utilizados para autenticar la conexión a la API).
\n
/api/v1/manager/du: Muestra el tamaño de un archivo o directorio en bytes. Los parámetros de entrada incluyen \"path\" (ruta del archivo o directorio) y \"appConnect\" y \"keyUser\" (opcionales, utilizados para autenticar la conexión a la API).
\n
/api/v1/image/save: Guarda una imagen en formato base64. Los parámetros de entrada incluyen \"type\" (tipo de imagen, png, jpg, jpeg, gif, webp), \"quality\" (opcional, calidad de la imagen de 0 a 100), \"path\" (ruta de destino de la imagen) y \"name\" (nombre de la imagen) y \"base64\" (contenido de la imagen en formato base64) y \"appConnect\" y \"keyUser\" (opcionales, utilizados para autenticar la conexión a la API).
\n
/api/v1/file/save: Guarda un archivo en formato base64. Los parámetros de entrada incluyen \"name\" (nombre del archivo),\"type\" (tipo de archivo, dll, exe, lnk, apk, mp3, ra, wmv, avi, mov, mp2v, mp4, mpa, smk, bz, iso, rar, tar, tbz, tbz2, zip, doc, diz, dochtml, exc, txt, docx, docm, odt, pdf, rtf, csv, xls, xlsx, xlsm, ods, pps, ppt, ppsx, pptx, ppsm, pptm, potx, odp, wav, flac, midi, ogg, m3u, divx, mpg, mkv, wpl, ico, webp, jpeg, png, bmp, svg, gif, psd, heic, nef, crw, ai, id, java, rar5, 7z, ace, r00, r01, gz, tar.bz2, texto, img, html, xml, url, css, js, json), \"path\" (ruta de destino del archivo) y \"base64\" (contenido del archivo en formato base64) y \"appConnect\" y \"keyUser\" (opcionales, utilizados para autenticar la conexión a la API).\n Es importante tener en cuenta que para utilizar estas rutas es necesario tener una cuenta en YPW Account y utilizar la autenticación y autorización según lo especificado en la documentación de la API. Además, algunas de estas rutas pueden requerir permisos específicos para su uso.
\n
/api/v1/storage/{username}/get/?path=: Obtiene un archivo o documento específico a partir de una ruta específica. El parámetro de entrada es \"path\" (ruta completa del archivo o documento) y \"appConnect\" y \"keyUser\" (opcionales, utilizados para autenticar la conexión a la API).
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16743367","collectionId":"027fa4c0-a32a-4b83-a2a6-1f6f9fe11f70","publishedId":"2s93kz5kGp","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-18T05:20:57.000Z"},"item":[{"name":"manager","item":[{"name":"mkdir","id":"b8836263-9e71-4a73-973a-c7b528e5bc16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"path\": \"/documentos/juegos\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://storage.ypw.com.do/api/v1/manager/mkdir","description":"

La ruta de la API \"/api/v1/manager/mkdir\" se utiliza para crear un directorio en el sistema. Los parámetros de entrada para esta ruta incluyen:

path: es un parámetro obligatorio que especifica la ruta y nombre de la carpeta a crear. Por ejemplo, en el ejemplo dado, el directorio se llamaría \"juegos\" y se encontraría en la carpeta \"documentos\".
appConnect: es un parámetro opcional que especifica el nombre de usuario para conectarse a la API. Puede ser enviado en el header, auth Basic
keyUser: es un parámetro opcional que especifica la clave para conectarse a la API. Puede ser enviado en el header, auth Basic.

La ruta requiere los siguientes encabezados:

Content-Type: application/json
Authorization: Basic (base64 encoded string)
En el cuerpo debe enviar el json con los datos de path para crear el directorio.

Ejemplo de petición en JSON:

Copy codePOST https://storage.ypw.com.do/api/v1/manager/mkdir\nContent-Type: application/json\nAuthorization: Basic encodedstring\n\n{\n    \"path\": \"/documentos/juegos\"\n}\n\n

Nota: Es importante seguir las instrucciones de seguridad, autenticación y autorización que se proporcionan en la documentación de la API antes de utilizar esta ruta.

Es importante tener en cuenta que esta información puede variar dependiendo de la implementación específica de la API. Asegúrese de consultar la documentación oficial de la API para obtener información precisa y detallada sobre cómo utilizar esta ruta.

para utilizar la ruta de la API \"/api/v1/manager/mkdir\" en https://storage.ypw.com.do/ se necesita tener una cuenta en YPW Account. Puede obtener el nombre de usuario (appConnect) y la clave (keyUser) al crear una cuenta en YPW Account.

Para crear una cuenta en YPW Account, se recomienda seguir los siguientes pasos:

Acceda al sitio web oficial de YPW en ypw.com.do
Haga clic en el enlace \"Crear una cuenta\" o \"Registrarse\" en la página de inicio.
Complete el formulario de registro con la información requerida, como su nombre, correo electrónico y contraseña.
Haga clic en el botón \"Registrarse\" para completar el proceso de registro.
Una vez registrado, inicie sesión con sus credenciales en YPW Account
Acceda a la sección de API keys dentro de su cuenta y genere sus credenciales de API, en esa misma sección encontrará la documentacion completa para utilizar la API.
Utilice las credenciales (appConnect y keyUser) proporcionadas para conectarse a la API y utilizar la ruta \"/api/v1/manager/mkdir\".

Nota: Es importante guardar las credenciales de forma segura y no compartirlas con terceros.

La ruta de la API \"/api/v1/manager/rm\" se utiliza para eliminar un archivo o directorio completo en el sistema. Los parámetros de entrada para esta ruta incluyen:

path: es un parámetro obligatorio que especifica la ruta y nombre del archivo o directorio a eliminar. Por ejemplo, en el ejemplo dado, el directorio se llamaría \"juegos\" y se encontraría en la carpeta \"documentos\".
appConnect: es un parámetro opcional que especifica el nombre de usuario para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic
keyUser: es un parámetro opcional que especifica la clave para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic.

La ruta requiere los siguientes encabezados:

Content-Type: application/json
Authorization: Basic (base64 encoded string)
En el cuerpo debe enviar el json con los datos de path para eliminar el archivo o directorio.

Ejemplo de petición en JSON:

DELETE\nhttps://storage.ypw.com.do/api/v1/manager/rm\nContent-Type: application/json\nAuthorization: Basic encodedstring\n{\n    \"path\": \"/documentos/juegos\"\n}\n\n

Nota: Es importante seguir las instrucciones de seguridad, autenticación y autorización que se proporcionan en la documentación de la API antes de utilizar esta ruta.

La ruta de la API \"/api/v1/manager/ls\" se utiliza para listar los archivos y directorios en el sistema. Los parámetros de entrada para esta ruta incluyen:

path: es un parámetro obligatorio que especifica la ruta del directorio para listar los archivos y directorios. Por ejemplo, en el ejemplo dado, el directorio se llamaría \"documentos\".
appConnect: es un parámetro opcional que especifica el nombre de usuario para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic
keyUser: es un parámetro opcional que especifica la clave para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic.

La ruta requiere los siguientes encabezados:

Content-Type: application/json
Authorization: Basic (base64 encoded string)
En el cuerpo debe enviar el json con los datos de path para listar los archivos y directorios.

Ejemplo de petición en JSON:

GET https://storage.ypw.com.do/api/v1/manager/ls\nContent-Type: application/json\nAuthorization: Basic encodedstring\n\n{\n    \"path\": \"/documentos\"\n}\n\n

Nota: Es importante seguir las instrucciones de seguridad, autenticación y autorización que se proporcionan en la documentación de la API antes de utilizar esta ruta.

Además, es importante tener en cuenta que al utilizar esta ruta, solo se listarán los archivos y directorios dentro de la ruta especificada en el parámetro \"path\". Si se desea listar todos los archivos y directorios en el sistema, deberá especificar la ruta raíz del sistema en el parámetro \"path\".

La ruta de la API \"/api/v1/manager/find\" se utiliza para buscar archivos en el sistema. Los parámetros de entrada para esta ruta incluyen:

search: es un parámetro obligatorio que especifica el nombre del archivo a buscar.
path: es un parámetro obligatorio que especifica la ruta del directorio donde se buscará el archivo. Por ejemplo, en el ejemplo dado, el directorio sería \"documentos\".
appConnect: es un parámetro opcional que especifica el nombre de usuario para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic
keyUser: es un parámetro opcional que especifica la clave para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic.
La ruta requiere los siguientes encabezados:

Content-Type: application/json
Authorization: Basic (base64 encoded string)
En el cuerpo debe enviar el json con los datos de path y search para buscar el archivo.
Ejemplo de petición en JSON:

GET https://storage.ypw.com.do/api/v1/manager/find\nContent-Type: application/json\nAuthorization: Basic encodedstring\n\n{\n\"path\": \"/documentos\",\n\"search\":\"image.jpg\"\n}\n\n

Nota: Es importante seguir las instrucciones de seguridad, autenticación y autorización que se proporcionan en la documentación de la API antes de utilizar esta ruta.

Para obtener las credenciales (appConnect y keyUser) necesarias para conectarse a la API, debe crear una cuenta en YPW Account. Una vez que haya iniciado sesión, podrá acceder a la sección de API keys dentinando de esta manera, podrá generar sus credenciales de API. Es importante tener en cuenta que esta información puede variar dependiendo de la implementación específica de la API. Asegúrese de consultar la documentación oficial de la API para obtener información precisa y detallada sobre cómo utilizar esta ruta.

Además, es importante tener en cuenta que al utilizar esta ruta, se buscará el archivo especificado en el parámetro \"search\" dentro de la ruta especificada en el parámetro \"path\" y sus subdirectorios. Si se desea buscar el archivo en todo el sistema, deberá especificar la ruta raíz del sistema en el parámetro \"path\".

Es importante mencionar que esta documentacion se basa en un hipotetico sistema de almacenamiento y puede variar dependiendo de la implementacion especifica de la ruta find, por favor asegurese de consultar la documentacion oficial de su sistema para obtener informacion precisa.

La ruta de la API \"/api/v1/manager/mv\" se utiliza para mover un archivo o directorio en el sistema y también para renombrarlo si se especifica una ruta de destino diferente. Los parámetros de entrada para esta ruta incluyen:

src: es un parámetro obligatorio que especifica la ruta del archivo o directorio a mover.
dest: es un parámetro obligatorio que especifica la ruta de destino donde se moverá el archivo o directorio. Si la ruta de destino especificada es diferente del nombre original, el archivo o directorio se renombrará.
appConnect: es un parámetro opcional que especifica el nombre de usuario para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic
keyUser: es un parámetro opcional que especifica la clave para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic.

La ruta requiere los siguientes encabezados:

Content-Type: application/json
Authorization: Basic (base64 encoded string)
En el cuerpo debe enviar el json con los datos de src y dest para mover el archivo o directorio.

Ejemplo de petición en JSON:

POST https://storage.ypw.com.do/api/v1/manager/mv\nContent-Type: application/json\nAuthorization: Basic encodedstring\n\n{\n    \"src\": \"/juegos/documentos\",\n    \"dest\": \"/juegos/documentosDestino\"\n}\n\n

Nota: Es importante seguir las instrucciones de seguridad, autenticación y autorización que se proporcionan en la documentación de la API antes de utilizar esta ruta.

La ruta de la API \"/api/v1/manager/du\" se utiliza para ver el tamaño de un archivo o directorio en bytes. Los parámetros de entrada para esta ruta incluyen:

path: es un parámetro obligatorio que especifica la ruta del archivo o directorio del cual se desea ver el tamaño.
appConnect: es un parámetro opcional que especifica el nombre de usuario para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic
keyUser: es un parámetro opcional que especifica la clave para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic.

La ruta requiere los siguientes encabezados:

Content-Type: application/json
Authorization: Basic (base64 encoded string)
En el cuerpo debe enviar el json con los datos de path para ver el tamaño del archivo o directorio.

Ejemplo de petición en JSON:

GET https://storage.ypw.com.do/api/v1/manager/du\nContent-Type: application/json\nAuthorization: Basic encodedstring\n\n{\n    \"path\": \"/documentos/juegos\"\n}\n\n

Nota: Es importante seguir las instrucciones de seguridad, autenticación y autorización que se proporcionan en la documentación de la API antes de utilizar esta ruta.

Es importante tener en cuenta que el tamaño del archivo o directorio se devuelve en bytes, si desea ver la medida en kb o mb, tendrá que hacer la conversión usted mismo en la lógica de su aplicación.
Es importante tener en cuenta que esta información puede variar dependiendo de la implementación específica de la API. Asegúrese de consultar la documentación oficial de la API para obtener información precisa y detallada sobre cómo utilizar esta ruta.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"string"},{"key":"password","value":"string\n"}]},"isInherited":true,"source":{"_postman_id":"027fa4c0-a32a-4b83-a2a6-1f6f9fe11f70","id":"027fa4c0-a32a-4b83-a2a6-1f6f9fe11f70","name":"api-storage","type":"collection"}},"urlObject":{"path":["v1","manager","du"],"host":["http://localhost/api-ProductoStorageapi"],"query":[{"key":"path","value":"/"}],"variable":[]}},"response":[],"_postman_id":"9dfd8cb4-a396-4d7e-bfbc-3375929ec20f"}],"id":"cb9e4919-5a05-4d73-ab42-a7c4dc9d9adf","_postman_id":"cb9e4919-5a05-4d73-ab42-a7c4dc9d9adf","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"string"},{"key":"password","value":"string\n"}]},"isInherited":true,"source":{"_postman_id":"027fa4c0-a32a-4b83-a2a6-1f6f9fe11f70","id":"027fa4c0-a32a-4b83-a2a6-1f6f9fe11f70","name":"api-storage","type":"collection"}}},{"name":"image.save","id":"edec6cc6-7286-4741-87c1-3442a8abb9e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"jpg\",\n \"quality\": 70,\n \"path\": \"/juegos/\",\n \"name\": \"original\",\n \"base64\": \"\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://storage.ypw.com.do/api/v1/image/save","description":"

La ruta de la API \"/api/v1/image/save\" se utiliza para guardar una imagen en formato base64 en el sistema. Los parámetros de entrada para esta ruta incluyen:

type: es un parámetro obligatorio que especifica el tipo de imagen a guardar. Los tipos de imágenes aceptadas son: \"png\", \"jpg\", \"jpeg\", \"gif\" y \"webp\"
quality: es un parámetro opcional que especifica la calidad de la imagen a guardar. El valor debe ser un número entre 0 y 100. Donde la calidad 100 es original y 0 es máxima compresión. Tenga en cuenta que esta opción solo se aplica a imágenes jpeg y webp.
path: es un parámetro obligatorio que especifica la ruta donde se guardará la imagen en el sistema.
name: es un parámetro obligatorio que especifica el nombre de la imagen a guardar.
base64: es un parámetro obligatorio que especifica el contenido de la imagen en formato base64.
appConnect: es un parámetro opcional que especifica el nombre de usuario para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic
keyUser: es un parámetro opcional que especifica la clave para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic.

La ruta requiere los siguientes encabezados:

Content-Type: application/json
Authorization: Basic (base64 encoded string)
En el cuerpo debe enviar el json con los datos de path, type, quality, name y base64 para guardar la imagen.

Ejemplo de petición en JSON:

POST\n/api/v1/image/save\nContent-Type: application/json\nAuthorization: Basic encodedstring\n{\n\"type\": \"jpg\",\n\"quality\": 80,\n\"path\": \"/juegos/\",\n\"name\": \"original\",\n\"base64\": \"dGhpcyBpcyBteSBpbWFnZQo=...\"\n}\n\n

Nota: Es importante seguir las instrucciones de seguridad, autenticación y autorización que se proporcionan en la documentación de la API antes de utilizar esta ruta.

La ruta de la API \"/api/v1/file/save\" se utiliza para guardar un archivo en formato base64 en el sistema. Los parámetros de entrada para esta ruta incluyen:

name: es un parámetro obligatorio que especifica el nombre del archivo a guardar.
type: es un parámetro obligatorio que especifica el tipo de archivo a guardar, los tipos aceptados son: dll, exe, lnk, apk, mp3, ra, wmv, avi, mov, mp2v, mp4, mpa, smk, bz, iso, rar, tar, tbz, tbz2, zip, doc, diz, dochtml, exc, txt, docx, docm, odt, pdf, rtf, csv, xls, xlsx, xlsm, ods, pps, ppt, ppsx, pptx, ppsm, pptm, potx, odp, wav, flac, midi, ogg, m3u, divx, mpg, mkv, wpl, ico, webp, jpeg, png, bmp, svg, gif, psd, heic, nef, crw, ai, id, java, rar5, 7z, ace, r00, r01, gz, tar.bz2, texto, img, html, xml, url, css, js, json.
path: es un parámetro obligatorio que especifica la ruta donde se guardará el archivo en el sistema.
base64: es un parámetro obligatorio que especifica el contenido del archivo en formato base64.
appConnect: es un parámetro opcional que especifica el nombre de usuario para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic
keyUser: es un parámetro opcional que especifica la clave para conectarse a la API. Se obtiene al crear una cuenta en YPW Account. Puede ser enviado en el header, auth Basic.

La ruta requiere los siguientes encabezados:

Content-Type: application/json
Authorization: Basic (base64 encoded string)
En el cuerpo debe enviar el json con los datos de path, type, name y base64 para guardar el archivo.

Ejemplo de petición en JSON:

POST https://storage.ypw.com.do/api/v1/file/save\nContent-Type: application/json\nAuthorization: Basic encodedstring\n{\n    \"name\": \"juegoX\",\n    \"type\": \"zip\",\n    \"path\": \"/juegos/docuemntos\"\n    \"base64\": \"dGhpcyBpcyBteSBhcmNoaXZlCg==...\"\n}\n\n

Nota: Es importante seguir las instrucciones de seguridad, autenticación y autorización que se proporcionan en la documentación de la API antes de utilizar esta ruta.

La ruta \"/api/v1/storage/{username}/get/?path=/documentos/juegos/juegoX.jpeg\" se utiliza para obtener un archivo o documento en particular del sistema. El parámetro de entrada necesario para esta ruta es la ruta del archivo o documento que se desea obtener, en este caso \"/documentos/juegos/juegoX.jpeg\".

En la ruta \"/api/v1/storage/{username}/get/?path=/documentos/juegos/juegoX.jpeg\" el parámetro de entrada es \"path\" que especifica la ruta completa del archivo o documento que se desea obtener. El parámetro se incluye en la URL como \"?path=\", seguido de la ruta del archivo o documento. En este ejemplo, la ruta es \"/documentos/juegos/juegoX.jpeg\", lo que indica que el archivo o documento que se desea obtener se encuentra en la carpeta \"juegos\" dentro de la carpeta \"documentos\".

Este parámetro es obligatorio ya que es necesario especificar la ubicación del archivo o documento para obtenerlo. Es importante asegurarse de que la ruta especificada sea válida y que el archivo o documento exista en el sistema antes de intentar obtenerlo.

La ruta también requiere que se especifique el nombre de usuario en {username} para conectarse a la API utilizando la cuenta de YPW Account. El nombre de usuario se obtiene al crear una cuenta en YPW Account.

Esta ruta debe utilizar el método GET y no requiere ningún otro parámetro o autenticación adicional. Sin embargo, es importante seguir las instrucciones de seguridad, autenticación y autorización que se proporcionan en la documentación de la API antes de utilizar esta ruta.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"string"},{"key":"password","value":"string\n"}]},"isInherited":true,"source":{"_postman_id":"027fa4c0-a32a-4b83-a2a6-1f6f9fe11f70","id":"027fa4c0-a32a-4b83-a2a6-1f6f9fe11f70","name":"api-storage","type":"collection"}},"urlObject":{"path":["v1","storage","yolfry","get",""],"host":["https://storage.ypw.com.do/api"],"query":[{"key":"path","value":"/documentos/juegos/juegoX.jpeg"}],"variable":[]}},"response":[],"_postman_id":"92efe7e1-ea98-4a8b-a64d-60bf4e9b402e"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"string"},{"key":"password","value":"string\n"}]}},"event":[{"listen":"prerequest","script":{"id":"1cf41f06-ed74-4d03-a521-97c61e9570f2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"82f58aee-5b63-43ce-acae-9fc954131163","type":"text/javascript","exec":[""]}}],"variable":[{"key":"localhost","value":"http://localhost/api-ProductoStorage","type":"string"},{"key":"server","value":"https://storage.ypw.com.do/","type":"string"},{"key":"appConnect","value":"string","type":"string"},{"key":"keyUser","value":"string\n","type":"string"}]}