Actualización importante: Tenga en cuenta que la API V3 quedará obsoleta en breve y dejará de recibir actualizaciones o soporte más allá de su fecha de fin de vida útil. Para beneficiarse de las funciones y el rendimiento mejorados, le recomendamos encarecidamente que pase a nuestra nueva API V4. Hemos preparado una guía completa que detalla los pasos para empezar a trabajar con V4 para que el proceso le resulte lo más sencillo posible.
Couchbase Capella ofrece una API pública que permite a los administradores y desarrolladores integrar e interactuar con el Plano de Control utilizando una variedad de lenguajes de programación y plataformas. Las API RESTful están pensadas para que los clientes puedan integrarse con Couchbase Capella y realizar operaciones como:
-
- Alta y baja de usuarios
- Gestión del ciclo de vida de una base de datos
- Supervisión de una base de datos
Esta entrada del blog le mostrará cómo utilizar el Cliente API Postman para interactuar con la API pública de Couchbase Capella a través de la interfaz REST.
Tenga en cuenta que este tutorial utiliza la v3 de la API pública de Capella. Se está trabajando en una versión renovada de la API que puede introducir algunos cambios de última hora. Por ello, le desaconsejamos que utilice esta versión de la API en despliegues de producción, ya que no garantizamos la compatibilidad con versiones anteriores de esta versión. No obstante, le animamos a que evalúe la API y le invitamos a que nos haga llegar sus comentarios sobre las funciones que le gustaría ver en la nueva versión de la API pública.
Requisitos previos
-
- Postman es una gran herramienta para interactuar con una API REST. En el resto de este tutorial asumo que has instalado Postman localmente y está listo para su uso. Puedes descargarlo desde postman.com/descargas
- El siguiente paso es descargar el archivo OpenAPI de Couchbase Capella desde el sitio web de Capella sitio web de documentación.
-
- También tendrá que crear una clave de acceso y una clave secreta para utilizar la API pública. Consulte las instrucciones para configurar sus claves aquí.
Crear un nuevo entorno Postman
En este paso configurarás un nuevo entorno Postman (un conjunto de variables que puedes usar en tus peticiones Postman). La API pública de Couchbase Capella requerirá tus claves de acceso y secretas.
Asegúrate de nombrar las variables exactamente como se indica a continuación:
-
- accessKey que contiene su clave de acceso
- secretKey que contiene su secreto
Probablemente sea mejor establecer este nuevo entorno como el activo.
Importar la definición OpenAPI
El siguiente paso es importar el archivo de definición OpenAPI que descargó anteriormente. Esto creará una nueva colección de Postman.
Llegados a este punto, ya tienes la colección y el entorno configurados en Postman.
Configurar la autenticación
La API pública de Couchbase Capella utiliza una Portador ficha para la autenticación; cada llamada a la API pública debe ser autenticada. Puede encontrar información detallada sobre las dos cabeceras que debe enviar con cada solicitud consultando la página documentación oficial en las cabeceras de seguridad.
Para ayudarle a empezar, disponemos de un script Postman de solicitud previa que genera las cabeceras necesarias basándose en sus claves de acceso y secretas.
Debe copiar y pegar este código en el Guión previo a la solicitud de la colección. Puede encontrar más información sobre los scripts de solicitud previa visitando la página de Postman sitio web de documentación.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
// Obtiene la información del endpoint actual de la petición const url = pm.solicitar.url.getPathWithQuery() // Obtener el método de la solicitud const método = pm.solicitar.método; // Crear una marca de tiempo const ahora = nuevo Fecha().getTime(); // Fecha en el pasado const ayer = nuevo Fecha(); ayer.setDate(ayer.getDate() - 1); // hash SHA-256 const createHash = (carga útil, secreto) => { devolver CryptoJS.HmacSHA256(carga útil, secreto) .toString(CryptoJS.enc.Base64); } // Crear el bearerToken const setToken = (accessKey, hash) => { pm.medio ambiente.configure("bearerToken", accessKey + ':' + hash); } // Crear la cabecera Timestamp const setTimestampheader = (fecha) => { pm.solicitar.cabeceras.añada({ clave: "Couchbase-Timestamp", valor: fecha }); } // Si accessKey y secretKey están definidos, podemos generar el hash si (pm.medio ambiente.tiene("accessKey") && pm.medio ambiente.tiene("secretKey")) { // Sustituir variables en la URL const parsedURL = pm.variables.replaceIn(url); // Generar la carga útil const carga útil = [método, parsedURL, ahora].únase a("\n"); consola.registro("Payload", carga útil); // Generar el hash const hash = createHash(carga útil, pm.medio ambiente.consiga("secretKey")) // Guardar el token en una variable env setToken(pm.medio ambiente.consiga("accessKey"), hash); // Añadir la cabecera timestamp a la solicitud setTimestampheader(ahora); } pm.medio ambiente.configure("ayer", ayer.toJSON()); pm.medio ambiente.configure("ahora", nuevo Fecha().toJSON()); |
En este punto ya está listo para ejecutar sus consultas. A continuación veremos cómo ejecutar algunas de las consultas Consultas a la API pública.
Ejecutar consultas
Como primer ejemplo, vamos a ejecutar la aplicación Lista de usuarios en la carpeta de usuarios.
Cuando ejecute esta consulta, observará que la respuesta está vacía a pesar de que tiene usuarios en su sistema. Esto se debe a que a los parámetros de consulta se les asignaron valores por defecto que son incorrectos.
Debe modificar los siguientes parámetros de consulta: página y perPage. En el siguiente ejemplo, cambiaré el página a 1 y el porPágina a 100 para obtener el resultado esperado de la API.
Ya está. Ahora estás listo para descubrir la API pública de Couchbase Capella. Espero que encuentres algunas formas interesantes de utilizarla en tu proyecto.
