Header Ads Widget

Ticker

6/recent/ticker-posts

Introducción a la API de Notion

 


Las herramientas de productividad digital son cruciales para la colaboración en línea y las configuraciones de trabajo desde casa. Incluso los proyectos modestos pueden tener una cantidad sorprendente de personas trabajando en ellos, y las empresas suelen tener muchos proyectos en curso que abordar simultáneamente. Por lo tanto, hemos visto un aumento en la popularidad de las herramientas de colaboración digital como los tableros Kanban; programas de mensajería como Slack ; software de programación como Buffer o posterior; y herramientas de diseño colaborativo como Sketch o Figma.

A veces, incluso hacer que nuestra propia pila coopere requiere una pizarra o un diagrama de flujo, y mucho menos agregar a otras personas a la mezcla. Las aplicaciones de terceros hacen que esto sea menos complicado, pero esto también puede dejarlo en deuda con los proveedores de terceros. Esto puede volverse caro rápidamente, ya que la mayoría de estos proveedores implican tarifas de suscripción mensuales.

Aquí es donde entra en juego Notion.

Para aquellos que aún no están familiarizados, Notion es una popular herramienta de productividad de código abierto que le permite crear sus propias herramientas de casi cualquier forma que pueda imaginar. En su forma más básica, Notion es la mejor revista digital bullet disponible actualmente, lo que le permite visualizar e interactuar con sus datos de la forma que mejor le parezca. Estas habilidades ayudan a crear mapas mentales y listas jerárquicas.

Sin embargo, eso es solo el comienzo de lo que Notion es capaz de hacer cuando agrega la capacidad de invitar a colaboradores remotos . Esto hace que este software engañosamente simple sea capaz de crear todo, desde listas de tareas pendientes hasta sistemas personalizados de administración de contenido y todo lo que una hoja de cálculo es capaz de hacer. Debido a su flexibilidad, Notion ha desarrollado una base de fans casi fanática. Lo único que le faltaba a Notion, según sus usuarios, era una API.

A fines de 2020, las oraciones de los usuarios de Notion finalmente fueron respondidas cuando se reveló una versión beta de Notion API. Esas demandas han demostrado estar bien justificadas, ya que puede hacer casi cualquier cosa con Notion cuando funciona con una API.

Para ofrecerle una idea de lo que es capaz de hacer la API de Notion, hemos preparado un breve tutorial sobre cómo utilizar la API de Notion. De esta manera, puede probarlo usted mismo y agregarlo a sus flujos de trabajo para ver de lo que es capaz.

Introducción a la API de Notion

Comenzar con la API de Notion es relativamente rápido y simple. Comience configurando una cuenta con Notion.

Si lo desea, puede tomar un momento y leer parte de la documentación en developers.notion.com para familiarizarse con la estructura de la API. Sin embargo, le brindaremos toda la información que necesita en este tutorial, por lo que no es necesario que aprenda a usar la API de Notion.

Para comenzar a usar la API de Notion usted mismo, comience por navegar a Mis integraciones o haga clic en la pestaña Mis integraciones en la esquina superior derecha de la página Desarrolladores. Haga clic + New Integrationy asigne un título a su nueva integración.

Crear una integración

Para este tutorial, imaginemos que estamos creando una integración para actualizar una base de datos cada vez que se crea una publicación de blog. Llamemos a esto Blog de integración.

En la ventana Integración, puede cargar una imagen para usarla como miniatura. También puede elegir qué espacio de trabajo desea conectar para poder crear integraciones para espacios de trabajo colaborativos o sus propios proyectos, por ejemplo.

Cree la integración y será llevado a una nueva página donde verá un campo etiquetado como Token de integración interna. Esta es esencialmente su clave API, así que guarde esta información en un lugar seguro para su uso posterior.

A continuación, vuelva a su espacio de trabajo de Notion y cree una nueva página seleccionando + Add A Pageen el menú de la izquierda. A continuación, dale un título. Lo llamaremos Base de datos de demostración en aras de la simplicidad. A continuación, cree la propia base de datos. Presione Enter para ir a una celda en blanco y escriba /tabley seleccione Table - Full Page ViewNota: los comandos en Notion están precedidos por un /.

Configurar la base de datos

Para este tutorial, imagine que está creando un Sistema de gestión de contenido (CMS) personalizado y desea tener una tabla que muestre el estado de publicación de cada publicación. Comience cambiando el nombre de la segunda columna para su función prevista. En este caso, estamos realizando un seguimiento del estado de publicación de las publicaciones de nuestro blog. Al nuestro lo llamamos Estado en aras de la simplicidad.

A continuación, haga clic en el encabezado de la segunda columna y elija la opción de selección múltiple. Esto revelará un segundo menú desplegable. Elija la opción Seleccionar, que le permite especificar los estados que desea que estén disponibles. Vamos a utilizar PublishedDraftsWritingIngrese cada uno en la segunda columna y luego elimine después de presionar enter en cada uno.

Luego, puede agregar una tercera columna para la imagen destacada de la publicación del blog. Titula esta columna Imagehaz clic en el encabezado, como antes. Seleccione el tipo de variable URL, que le permitirá almacenar la URL donde se almacena la imagen destacada. Puede hacer esto para tantas columnas como desee, especificando los tipos de datos que aceptará cada una.

Una vez que esté satisfecho con su base de datos, es hora de hacerla accesible a la integración que ha creado. Seleccione la pestaña Compartir en la esquina superior derecha de la página de la base de datos. Haga clic en Add people, emails, groups, or integrationsSeleccione el nombre de la integración en el menú desplegable y haga clic en Invitar. Ahora, cada vez que use ese token de integración interna, puede interactuar con esta base de datos en particular.

Consultar la API

Ahora veamos cómo consultar realmente los datos. Usaremos Postman para hacer nuestras llamadas API. En Postman, comience por crear una nueva Solicitud seleccionando el botón Nuevo a la derecha de Mi área de trabajo en el lado izquierdo de la pantalla. Ahora necesitamos conectar Postman a la API.

Esto requiere un poco de comprensión de cómo se configura Notion. Notion está organizado en tres niveles: bases de datos, páginas y bloques. En la base de datos que creamos, el objeto completo es la Base de datos. Cada una de las celdas individuales son páginas. Los elementos de las páginas individuales son bloques. Para este tutorial, vamos a conectar toda la base de datos.

Para obtener la dirección de API que Postman consultará, comience por echar un vistazo rápido a las Referencias de API . Seleccione la Query Databaseopción del menú de la izquierda. Aquí verá la dirección .https://api.notion.com/v1/databases/database_id/query

Para obtenerlo database_id, vuelva a su base de datos de demostración. El database_idproviene de la propia URL. Para aclarar, es la cadena de números y caracteres de 32 dígitos a la derecha /y a la izquierda del ?carácter. Inserte este ID en lugar de database_id.

A continuación, debe proporcionar el autenticador para que Postman pueda acceder a la base de datos. En Postman, seleccione la pestaña Autorización debajo del campo de la dirección API. En el menú desplegable junto a Tipo, elija Bearer Token. En la ventana que aparece, ingrese el Token de integración interno que guardó. Ahora continúe y envíe esa consulta para probar su consulta de API.

Desafortunadamente, notará que esto todavía le da un error.

La respuesta a la consulta debe decir "Validación fallida del encabezado Notion-Version: se debe definir el encabezado Notion-Version, en su lugar undefined". Esto significa que la consulta esperaba que se definiera la versión. Para encontrar esto, consulte la documentación de Post Database Query nuevamente. A la derecha, debería notar tres líneas de código en el ejemplo de cURL, a lo largo de las líneas de:

  -H 'Authorization: Bearer '"$NOTION_API_KEY"'' \
  -H 'Notion-Version: 2021-08-16' \
  -H "Content-Type: application/json" \

Ahora regrese a Postman y seleccione la tabla Encabezados junto a Autorización, donde ingresa la clave API. En la columna Clave, ingrese Notion-VersionEn la columna Valor, ingrese la versión que encontró en la documentación. Ahora intente la consulta nuevamente. El resultado de la consulta debe mostrar su base de datos en formato JSON.

Pruebe la API de Notion

Si desea ver la API de Notion en acción, agregue algunos elementos a su base de datos de demostración. Acabamos de hacer tres objetos hipotéticas llamadas 123en la columna Nombre.

Para ver qué hay dentro de la base de datos, debe modificar ligeramente su llamada a la API. En lugar de simplemente usar la dirección especificada por database_id, debe agregar /queryal final de su llamada API en Postman. También debe cambiar el tipo de HTTPS de GETPOSTAhora debería ver que el contenido de su base de datos regresa como un objeto JSON:

"title": [
                        {
                            "type": "text",
                            "text": {
                                "content": "2",
                                "link": null
                            },
                            "annotations": {
                                "bold": false,
                                "italic": false,
                                "strikethrough": false,
                                "underline": false,
                                "code": false,
                                "color": "default"
                            },
                            "plain_text": "2",
                            "href": null
                        }
                    ]
                }
            },
            "url": "https://www.notion.so/2-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        },
        {

Ver el objeto JSON también debería ayudar a ilustrar cómo Notion formatea sus datos como archivos JSON fuertemente anidados. Si está familiarizado con las API, sus ruedas ya deberían estar girando sobre diferentes formas en las que podría interactuar con sus datos sin procesar de prácticamente cualquier manera que pueda imaginar.

También permite que Notion actúe como el centro de prácticamente cualquier tarea. Por ejemplo, ya existen amplias integraciones para Notion y Zapier , que le permiten crear flujos de trabajo automatizados personalizados en todo tipo de formas creativas.

También hay integraciones predefinidas para Notion y Typeform , si desea conectar formularios o encuestas en línea a una base de datos de Notion. También hay amplias integraciones de Automate.io disponibles para Notion.

API de Notion: Reflexiones finales

El mundo y cómo hacemos negocios eran casi insoportablemente complejos antes de que la pandemia cambiara la colaboración en línea. Y si una cosa es cierta, el mundo no se volverá menos complejo a medida que avanza el tiempo. Incluso algo tan simple como organizar una venta de pasteles podría involucrar una cantidad increíble de partes móviles. No querrá estar en deuda con software propietario e inflexible si espera lograr todo lo que se espera de usted.

La API de Notion no podría llegar en un mejor momento, brindándole todo lo que necesita para crear sus propias integraciones y automatizaciones personalizadas utilizando casi cualquier herramienta que se le ocurra.


Publicar un comentario

0 Comentarios