¿Qué es una API, y la necesito?

Se encuentra con esas tres letras en el presupuesto de su desarrollador web, o en la lista de funciones de su programa de contabilidad: API. Este artículo explica qué es, sin que usted tenga que saber programar.

La respuesta corta

Una API es una puerta en la parte de atrás de su cuenta.

Donde usted hace clic en la pantalla de gestión para ver cuántas plazas quedan libres, otro programa puede pedir exactamente lo mismo por esa puerta — sin nadie delante de una pantalla. Detrás de las dos puertas están los mismos datos: sus productos, sus precios, sus plazas libres, sus ventas.

La diferencia está en quién entra. Por la puerta principal entra una persona con un ratón. Por la puerta de atrás entra un programa con una clave.

¿Cuándo la necesita?

Solo cuando quiere algo que la pantalla de gestión no hace. Por ejemplo:

• mostrar en su propia web qué visitas tienen aún sitio esta semana, con su propio diseño y con cifras correctas en ese mismo momento;
• dejar que su asesor se sirva solo, para que recoja él la facturación del mes pasado en lugar de recibir una exportación suya cada mes;
• una pantalla en el vestíbulo que muestra qué franja horaria empieza enseguida;
• vender desde un programa que ya usa, sin tener que entrar antes en la pantalla de gestión.

¿Y cuándo no la necesita? Cuando puede hacer clic. Construir una integración cuesta tiempo y mantenimiento; exportar una lista dos veces al mes cuesta dos minutos. Elija lo primero solo cuando lo segundo empiece a estorbar.

Atención: no tiene que construirlo usted. Quien lo construya — su desarrollador web, el proveedor de su programa de contabilidad, alguien de la junta que sepa programar — solo necesita dos cosas de usted: la dirección y una clave. Las dos están en su pantalla de gestión.

Qué entrega exactamente

Abra Ajustes → Acceso API (esa pantalla está reservada al propietario de la organización). En la pestaña Claves hay tres cosas que puede entregar:

1. La dirección. Una línea de texto. Es adonde habla el otro programa.
2. La descripción técnica, el enlace que termina en openapi.json. Con ella un desarrollador ve de un vistazo todo lo que se puede hacer: qué datos hay, cómo se piden, qué vuelve.
3. Una clave, que crea usted mismo. Vea Crear una clave API.

No necesita nada más, y usted tampoco debe dar nada más — su contraseña desde luego que no.

Qué puede y qué no puede una clave

Al crearla marca lo que la clave puede hacer. No es una formalidad:

• Lectura — consultarlo todo, no cambiar nada. Es lo que necesitan la mayoría de las integraciones. Atención: «todo» incluye también sus pedidos y sus compradores, con su nombre y su dirección de correo.
• Escritura — crear pedidos, cobrarlos, cancelarlos y reembolsarlos, solicitar una factura, anular y reenviar entradas, registrar accesos, y emitir, canjear o renovar tarjetas regalo y abonos anuales.
• Webhooks — indicar adónde pueden ir los mensajes. Vea Webhooks.
• Pagado externamente — marcar un pedido como pagado sin que intervenga un proveedor de pagos (transferencia, efectivo). Délo solo a una caja o a una contabilidad que usted gestione: quien puede hacerlo, puede emitir entradas sin que entre dinero.

Dé a cada integración su propia clave con solo lo que necesita. Así puede revocar una sin romper el resto, y ve en la lista cuál se sigue usando.

Una clave, por cierto, no es una contraseña que abre su cuenta: solo concede lo que está marcado en ella y pertenece a una sola organización. Aunque ande por ahí suelta, nadie puede consultar con ella los datos de otra persona.

Primero probar sin riesgo

Junto a una clave normal puede crear una clave de prueba. Lee exactamente los mismos datos. Si también puede escribir, solo crea pedidos de prueba: nunca pasan por su proveedor de pagos, no cuentan en su facturación y se eliminan automáticamente al cabo de 24 horas. Una clave de prueba no puede configurar webhooks.

Existe precisamente para este momento — alguien que está probando y aún no sabe seguro qué hace. Deje que su desarrollador empiece con una clave de prueba y cambie solo al final.

Algo que conviene saber: un pedido de prueba también retiene una plaza real (hasta que se elimina), y el correo de confirmación se envía de verdad. Por eso, haga que su desarrollador pruebe con un producto o una franja horaria creados para ello.

¿Y si sale mal?

Revoque la clave. Haga clic en Revocar en la lista y desde ese momento deja de funcionar. La integración se para, sus datos se quedan. No hay ninguna situación en la que una clave pueda hacer algo que usted no pueda detener con un clic.

Lo que cuesta

La API forma parte de un plan mayor. En uno menor, Acceso API no aparece en su menú. Si aun así llega a esa pantalla, verá una explicación, en qué plan está la API y un botón Ir a la suscripción — ninguna clave. Lo que hay en cada plan está en la página de precios de Passavo.

Siga leyendo

• Crear una clave API — la pantalla misma, paso a paso.
• Webhooks — avisar a su web de que se ha vendido algo, sin que tenga que seguir preguntándolo.
• Configurar webhooks — la pantalla misma, paso a paso.
• El portal para desarrolladores — para quien construye la integración.