pocketdb api

PocketDB-API

API REST artesanal para PocketDb.js - Pocket Database Wrapper para Telegra.ph

 // GET https://pocketdb-api.vercel.app/get?token=my-token&key=users
{
  "success" : true ,
  "result" : {
    "list" : [ "users" ] ,
    "data" : [ {
      "name" : "John Doe" ,
      "age" : 24 ,
      "email" : "[email protected]"
    } ]
  } ,
  "request" : {
    "endpoint" : "/get" ,
    "token" : "my-token" ,
    "key" : "users"
  }
}

Pruébalo en línea

pocketdb-api ofrece uso en línea en /web/index.html

Puntos finales

Punto final	Método	Parámetros
/set	CORREO	clave, *token
/get	CONSEGUIR	clave, token

* - Opcional

Documentación

/set con token

 POST https://pocketdb-api.vercel.app/set?token=...&key=...

Al utilizar /set con un token, modificará o creará datos asociados con la clave especificada, utilizando el contenido JSON proporcionado en el cuerpo de solicitudes.

 await fetch ( "https://pocketdb-api.vercel.app/set?token=...&key=users" , {
  method : "post" ,
  body : JSON . stringify ( {
    name : "John Doe" ,
    age : 24 ,
    email : "[email protected]"
  } )
} )

La salida se vería así:

 {
  "success" : true ,
  "result" : {
    "list" : [ "users" ]
  } ,
  "request" : {
  "endpoint" : "/set" ,
    "key" : "users" ,
    "value" : {
      "name" : "John Doe" ,
      "age" : 24 ,
      "email" : "[email protected]"
    } ,
    "token" : "..."
  }
} 

/set sin token

 POST https://pocketdb-api.vercel.app/set?&key=...

Cuando se use /set sin un token, iniciará una nueva base de datos e insertará datos asociados con la clave proporcionada, utilizando el contenido JSON proporcionado en el cuerpo de solicitud.

 await fetch ( "https://pocketdb-api.vercel.app/set?key=users" , {
  method : "post" ,
  body : JSON . stringify ( {
    name : "John Doe" ,
    age : 24 ,
    email : "[email protected]"
  } )
} )

La salida se vería así:

 {
  "success" : true ,
  "result" : {
    "list" : [ "users" ] ,
    "token" : "..."
  } ,
  "request" : {
    "endpoint" : "/set" ,
    "key" : "users" ,
    "value" : {
      "name" : "John Doe" ,
      "age" : 24 ,
      "email" : "[email protected]"
    }
  }
} 

/get

 GET https://pocketdb-api.vercel.app/get?token=...&key=...

Este punto final recupera el contenido de datos asociado con la clave proporcionada y lo devuelve en formato JSON.

 await fetch ( "https://pocketdb-api.vercel.app/get?token=...&key=users" )

La salida se vería así:

 {
  "success" : true ,
  "result" : {
    "list" : [ "users" ] ,
    "data" : {
      "name" : "John Doe" ,
      "age" : 24 ,
      "email" : "[email protected]"
    }
  } ,
  "request" : {
    "endpoint" : "/get" ,
    "key" : "users" ,
    "token" : "..."
  }
} 

Errores

Punto final	Error	Mensaje	Causa
/set	INCOMPLETE_PARAM	Parámetros incompletos. Vea la documentación https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation para obtener más información.	Se requiere la key de parámetro. Así como el cuerpo como JSON.
/set	INVALID_BODY	El cuerpo no está codificado correctamente. Vea la documentación https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation para obtener más información.	El cuerpo debe ser un JSON válido Stringified. Se espera una cadena
/set	INVALID_METHOD	Post es el único método aceptado para el punto final /set	El punto final /set solo acepta el método POST .
/get	INCOMPLETE_PARAM	Parámetros incompletos. Vea la documentación https://github.com/creuserr/pocketdb-api/blob/main/readme.md#documentation para obtener más información.	Se requieren la key y token de parámetros.
/get	INVALID_METHOD	Get es el único método aceptado para el punto final /get	El punto final /get solo acepta el método GET .
/set o /get	INTERNAL_ERROR	Mensaje de error	Este error puede variar según el error elevado. Las posibles causas incluyen JSON inválido, falla de conexión, base de datos que no se encuentra (el token no existe) o la clave no se encuentra.

 // Example Error:
// POST https://pocketdb-api.vercel.app/get?token=...&key=...

{
  "success" : false ,
  "error" : "INVALID_METHOD" ,
  "message" : "GET is the only method accepted for the endpoint /get" ,
  "request" : {
    "token" : "..." ,
    "key" : "..." ,
    "endpoint" : "/get"
  }
}