DOKKY SUITE Demo Documentación de la API

En esta sección puede verificar las diversas solicitudes y requisitos de la API.

Instrucciones


Se requiere un Token JWT para que las solicitudes sean procesadas por el sistema.

Una vez que un usuario se registra, se genera automáticamente un Token JWT para este usuario.

Si el JWT no se envía o ha caducado, habrá un error.

Por favor, asegúrese de guardar su Token JWT en un lugar seguro para evitar abusos.

AD 350 x 600

DOKKY SUITE Demo - REFERENCIA DE LA API PARA DESARROLLADORES




AUTENTICACIÓN


Nota: Para autenticarse con el sistema de la API, debe enviar su JWT como un Token de Autorización con cada solicitud. Puede ver el código de ejemplo a continuación.


LÍMITE DE VELOCIDAD


Nota: Nuestra API tiene un limitador de velocidad para protegerse contra picos en las solicitudes y maximizar su estabilidad. Nuestro limitador de velocidad está actualmente limitado a 30 solicitudes por minuto.
Se enviarán varios encabezados junto con la respuesta y estos pueden ser examinados para determinar diversa información sobre la solicitud.


MANEJO DE RESPUESTAS


Nota: Todas las respuestas de la API se devuelven en formato JSON por defecto.
Para convertir esto en datos utilizables, se deberá usar la función apropiada según el lenguaje. En PHP, por ejemplo, la función json_decode() puede usarse para convertir los datos a un objeto (por defecto) o a un array (establezca el segundo parámetro en true).
Es muy importante verificar la clave de error ya que proporciona información sobre si hubo un error o no.
También puede verificar el código del encabezado.


API Cargar Archivo - [POST]



Esta API le permite cargar un archivo al servidor especificando varios metadatos como el título, la descripción, las etiquetas y la licencia. También puede crear una nueva categoría para el archivo si es necesario.

Ejemplo de solicitud curl
curl -X POST "https://dokky.scriptnet.net/api/V1/docs/api-upload" \
-H "X-Authorization: Bearer Your JWT Token here" \
-H "Content-Type: multipart/form-data" \
-F "file=@/path/to/your/file.pdf" \
-F "title=Upload via API" \
-F "description=Upload File via API" \
-F "tags=tag1, tag2, upload, api, pdf, scriptnet" \
-F "category_id=1" \
-F "cc_license=CC BY" \
Parámetros requeridos
  • file (requerido): El archivo a subir.
  • title (requerido): El título del archivo.
  • description (requerido): Una descripción del archivo.
  • tags (requerido): Las etiquetas asociadas con el archivo, separadas por comas.
  • category_id (requerido): El ID de la categoría existente.
  • new_category_name (opcional): El nombre de la nueva categoría a crear (si no se proporciona category_id).
  • category_description (opcional): La descripción de la nueva categoría.
  • category_tags (opcional): Las etiquetas asociadas con la nueva categoría, separadas por comas.
  • cc_license (requerido): La licencia Creative Commons para el archivo (por ejemplo, 'CC BY') (List).
  • video (opcional): URL de un video asociado (por ejemplo, YouTube o Vimeo).
Ejemplo de una solicitud completa
curl -X POST "https://dokky.scriptnet.net/api/V1/docs/api-upload" \
-H "X-Authorization: Bearer Your JWT Token here" \
-H "Content-Type: multipart/form-data" \
-F "file=@/path/to/your/file.pdf" \
-F "title=Upload via API" \
-F "description=Upload File via API" \
-F "tags=tag1, tag2, upload, api, pdf, scriptnet" \
-F "new_category_name=New Category Name" \
-F "category_description=New Category Description" \
-F "category_tags=tag1, tag2" \
-F "cc_license=CC BY-NC-ND" \
-F "video="
Respuesta de ejemplo
{ "status": "success", "message": "File uploaded successfully.", "file_id": "12345", "category_id": "1", "category_name": "New Category"
}

API Descargar Archivo - [GET]



Esta API le permite descargar un archivo del servidor especificando el ID del archivo. Verifica que el archivo esté disponible para descargar y que no esté a la venta o deshabilitado.

Ejemplo de solicitud curl
curl -X GET "https://dokky.scriptnet.net/api/V1/docs/api-download?file_id=123" \
-H "X-Authorization: Bearer Your JWT Token here"
Parámetros requeridos
  • file_id (requerido): El ID del archivo a descargar.
  • Header X-Authorization: Token JWT requerido para la autenticación.
Ejemplo de una solicitud completa
curl -X GET "https://dokky.scriptnet.net/api/V1/docs/api-download?file_id=123" \
-H "X-Authorization: Bearer Your JWT Token here"

Respuesta exitosa
{ "status": "success", "original_file_name": "File_Name.pdf", "message": "File downloaded successfully"
}

Posibles respuestas de error
{ "status": "error", "message": "Rate limit exceeded. Please try again later."
}
{ "status": "error", "message": "File ID is required"
}
{ "status": "error", "message": "File not found"
}
{ "status": "error", "message": "File is either for sale or not enabled"
}
{ "status": "error", "message": "Invalid request method"
}

API Eliminar Archivo - [DELETE]



Esta API le permite eliminar un archivo especificando su ID. Se requiere un token JWT válido para autenticar la solicitud de eliminación del archivo.

Ejemplo de solicitud curl
curl -X DELETE "https://dokky.scriptnet.net/api/V1/docs/api-delete" \
-H "X-Authorization: Bearer Your JWT Token here" \
-H "Content-Type: application/json" \
-d '{"id": "20"}'
Parámetros requeridos
  • id (requerido): El ID del archivo a eliminar.
  • Header X-Authorization: Token JWT requerido para la autenticación.
  • Header Content-Type: Establecer en application/json para enviar datos en formato JSON.
Ejemplo de una solicitud completa
curl -X DELETE "https://dokky.scriptnet.net/api/V1/docs/api-delete" \
-H "X-Authorization: Your JWT Token here \
-H "Content-Type: application/json" \
-d '{"id": "20"}'
Respuesta exitosa
{ "status": "success", "message": "File deleted successfully"
}
Posibles respuestas de error
{ "status": "error", "message": "Missing JWT token"
}
{ "status": "error", "message": "File ID is required"
}
{ "status": "error", "message": "File not found"
}
{ "status": "error", "message": "Invalid JWT token"
}
{ "status": "error", "message": "Error during deletion"
}

API Buscar Archivo - [POST]



Esta API le permite buscar archivos especificando un término de búsqueda. Se requiere un token JWT válido para autenticar la solicitud de búsqueda.

Ejemplo de solicitud curl
curl -X POST "https://dokky.scriptnet.net/api/V1/stats/api-search" \
-H "X-Authorization: Bearer Your JWT Token here" \
-H "Content-Type: application/json" \
-d '{"search": "your-search-term"}'
Parámetros requeridos
  • search (requerido): El término de búsqueda utilizado para encontrar los archivos.
  • Header X-Authorization: Token JWT requerido para la autenticación.
  • Header Content-Type: Establecer en application/json para enviar datos en formato JSON.
Ejemplo de una solicitud completa
curl -X POST "https://dokky.scriptnet.net/api/V1/stats/api-search" \
-H "X-Authorization: Bearer Your JWT Token here" \
-H "Content-Type: application/json" \
-d '{"search": "document"}'
Respuesta exitosa
{ "status": "success", "results": [ { "id": "123", "title": "Document Title", "link": "https://dokky.scriptnet.net/view/123", "description": "A brief description of the document", "category": "Category Name", "tag": "tag1, tag2" } ]
}
Posibles respuestas de error
{ "status": "error", "message": "Missing JWT token"
}
{ "status": "error", "message": "Search term is required"
}
{ "status": "error", "message": "No results found"
}
{ "status": "error", "message": "Invalid JWT token"
}
{ "status": "error", "message": "Error during search"
}

API Estadísticas de Usuario - [POST]



Esta API proporciona estadísticas sobre el usuario autenticado, como el número total de comentarios, archivos cargados, vistas, descargas y ventas. Se requiere un token JWT válido para autenticar la solicitud.

Ejemplo de solicitud curl
curl -X POST "https://dokky.scriptnet.net/api/V1/stats/api-stats" \
-H "X-Authorization: Bearer Your JWT Token here" \
-H "Content-Type: application/json"
Parámetros requeridos
  • Header X-Authorization: Token JWT requerido para la autenticación.
  • Header Content-Type: Establecer en application/json para enviar datos en formato JSON..
Ejemplo de una solicitud completa>
curl -X POST "https://dokky.scriptnet.net/api/V1/stats/api-stats" \
-H "X-Authorization: Bearer Your JWT Token here" \
-H "Content-Type: application/json"
Respuesta exitosa
{ "status": "success", "data": { "total_comments": 45, "total_files": 120, "total_views": 10500, "total_downloads": 800, "total_sales": 50 }
}
Descripción de los campos en la respuesta
  • total_comments: Número total de comentarios del usuario.
  • total_files: Número total de archivos subidos por el usuario.
  • total_views: Número total de vistas de los archivos del usuario.
  • total_downloads: Número total de descargas de archivos del usuario.
  • total_sales: Número total de ventas de archivos del usuario.
Posibles respuestas de error
{ "status": "error", "message": "Missing JWT token"
}
{ "status": "error", "message": "Invalid JWT token"
}
{ "status": "error", "message": "Error fetching user stats"
}

API Archivos de Usuario - [GET]



Esta API le permite obtener la lista de archivos subidos por un usuario dado. Se requiere un token JWT válido para autenticar la solicitud. Puede especificar el ID del usuario para ver los archivos subidos.

Ejemplo de solicitud curl
curl -X GET "https://dokky.scriptnet.net/api/V1/users/api-files?user_id=1" \
-H "X-Authorization: Bearer Your JWT Token here" \
-H "Content-Type: application/json"
Parámetros requeridos
  • Query Parameter user_id: ID del usuario cuyos archivos desea obtener.
  • Header X-Authorization: Token JWT requerido para la autenticación.
  • Header Content-Type: Establecer en application/json para enviar datos en formato JSON..
Ejemplo de una solicitud completa
curl -X GET "https://dokky.scriptnet.net/api/V1/users/api-files?user_id=1" \
-H "X-Authorization: Bearer Your JWT Token here" \
-H "Content-Type: application/json"
Respuesta exitosa
{ "status": "success", "user": { "id": 1, "name": "John Doe" }, "files": [ { "file_id": 101, "upload_date": "2024-10-01", "title": "SEO Report", "description": "SEO Report October", "file_url": "https://dokky.scriptnet.net/view?report_october.pdf" }, { "file_id": 102, "upload_date": "2024-09-15", "title": "Preview SEO Project", "description": "Preview of the new SEO Project", "file_url": "https://dokky.scriptnet.net/view?project_preview.pdf" } ]
}
Descripción de los campos en la respuesta
  • status: Estado de la respuesta (por ejemplo, success).
  • user: Información del usuario (ID y nombre).
  • files: Lista de archivos subidos por el usuario.
  • file_id: ID único del archivo.
  • upload_date: Fecha en que se subió el archivo.
  • title: Título del archivo.
  • description: Descripción del archivo.
  • file_url: URL para acceder al archivo.
Posibles respuestas de error
{ "status": "error", "message": "Missing JWT token"
}
{ "status": "error", "message": "Invalid JWT token"
}
{ "status": "error", "message": "User not found"
}

API Comentarios de Usuario - [POST]



Esta API le permite obtener los comentarios recibidos por un usuario autenticado. Debe proporcionar un token JWT válido para acceder a este recurso.

Ejemplo de solicitud curl
curl -X POST "https://dokky.scriptnet.net/api/V1/users/api-comments" \
-H "X-Authorization: Bearer Your JWT Token here" \
-H "Content-Type: application/json"
Parámetros requeridos
  • Header X-Authorization: Token JWT requerido para la autenticación.
  • Header Content-Type: Establecer en application/json para enviar datos en formato JSON..
Ejemplo de una solicitud completa
curl -X POST "https://dokky.scriptnet.net/api/V1/users/api-comments" \
-H "X-Authorization: Bearer Your JWT Token here" \
-H "Content-Type: application/json"
Respuesta exitosa
{ "status": "success", "data": [ { "comment_id": 201, "submission_date": "2024-10-05", "title": "Monthly Report Project", "comment": "I love the details of this Project, compliments!", "link": "https://dokky.scriptnet.net/view/report_october" }, { "comment_id": 202, "submission_date": "2024-09-20", "title": "Project Introduction", "comment": "This is an exellent Introduction! Well done!", "link": "https://dokky.scriptnet.net/view/project_preview" } ]
}
Descripción de los campos en la respuesta
  • status: Estado de la respuesta (por ejemplo, success).
  • data: Lista de comentarios recibidos.
  • comment_id: ID único del comentario.
  • submission_date: Fecha en que se publicó el comentario.
  • title: Título del contenido al que se refiere el comentario.
  • comment: Texto del comentario recibido.
  • link: URL del contenido comentado.
Posibles respuestas de error
{ "status": "error", "message": "Missing JWT token"
}
{ "status": "error", "message": "Invalid JWT token"
}
{ "status": "error", "message": "User not found"
}