Obtener una clave
Cómo pedir una clave de la API de partners, qué incluir en la solicitud y qué recibe a cambio.
Las claves de partner se emiten a mano. Rellene el formulario de abajo —o escríbanos por correo electrónico, que llega a las mismas personas— y aprovisionamos la credencial y la enviamos al contacto que indique.
Una persona lee cada solicitud, porque una clave conlleva acceso a los registros de cumplimiento de un restaurante y el restaurante tiene que haberlo aceptado. Lo que eso le cuesta es una respuesta en lugar de una redirección; lo que compra es que nadie pueda fabricarse acceso a los datos de otro. El formulario pide todo lo que necesitamos para resolverla de una sola vez.
Quién puede pedirla
Cualquiera de las dos partes, pero el restaurante tiene que aceptar en ambos casos.
- Usted, el integrador. Diga qué restaurantes necesita e indique su contacto allí; lo confirmamos con ellos antes de emitir nada.
- El restaurante. Lo pide en su nombre y le identifica. Es la vía más rápida, porque la confirmación ya ha ocurrido.
No emitiremos una clave para un restaurante que no lo haya aceptado, y no ampliaremos una clave existente sin volver a preguntarle.
Solicitar una clave
Si integra para varios restaurantes que pertenecen a clientes distintos, envíe una solicitud por cliente. Una clave por cliente evita que una revocación tumbe todas las demás integraciones que tenga en marcha.
Dos de los campos merecen una nota. El entorno importa porque las claves y los datos son por entorno —una clave de producción no significa nada en preproducción—, así que dígalo si quiere desarrollar primero contra preproducción. Y los permisos deberían ser los que use, en lugar de todos: hay veintiséis, uno por colección más las entregas y sus fotografías, y el restaurante lee la lista antes de aceptarla. Nombrar los cuatro que necesita consigue un sí más rápido que pedirlos todos; consulte Autenticación para saber qué abre cada uno.
¿Ya tiene una clave y quiere una colección que no alcanza? Es el mismo correo electrónico, y una ampliación en lugar de una clave nueva: su secreto no cambia y no hay que volver a desplegar nada.
¿Prefiere escribirlo usted mismo? contact@backresto.com con los mismos datos llega a la misma bandeja de entrada.
Qué recibe a cambio
Un único valor, con la forma brp_<prefix>.<secret>, enviado al contacto técnico
que haya indicado.
Guárdela nada más recibirla y borre el correo. Solo conservamos el prefijo público y un resumen criptográfico del secreto, así que no podemos reenviarla: si se pierde, revocamos esa clave y emitimos una nueva, lo que supone otra ida y vuelta.
Las claves no caducan por sí solas. Siguen siendo válidas hasta que se revocan, y por eso la respuesta a «alguien ha dejado el equipo» es una rotación, no un encogimiento de hombros.
Cambiar una clave más adelante
Todo esto es un correo electrónico, y todo ello necesita el consentimiento del restaurante cuando amplía el acceso:
| Petición | Qué ocurre |
|---|---|
| Añadir un restaurante o un permiso | Ampliamos la clave existente. Su secreto no cambia y no hay que volver a desplegar nada. |
| Rotar | Primero emitimos una segunda clave, usted la despliega y después revocamos la antigua. Sin ninguna ventana en la que no funcione ninguna. |
| Revocar | Inmediato. La siguiente petición con esa clave responde 401. |
| Una clave con caducidad | Dígalo en la solicitud: para una auditoría puntual o una prueba de concepto, una clave que muere sola es más segura que una que hay que acordarse de matar. |
Para cualquier cosa urgente —un secreto filtrado por encima de todo— escriba a
contact@backresto.com
con el prefijo público de la clave (la mitad brp_… anterior al punto) y diga
que es urgente. Nunca nos envíe el secreto en sí, ni siquiera para demostrar a qué
clave se refiere.
Mientras espera
Nada de la documentación necesita una clave para leerse, y todas las formas están en estas páginas: el registro de entrega, las fotografías, las colecciones y los registros, el modelo de errores y la paginación. El documento OpenAPI también es público, así que puede generar un cliente y programar contra él antes de que llegue la clave.