Ottenere una chiave
Come richiedere una chiave dell'API Partner, cosa indicare nella richiesta e cosa si riceve.
Le chiavi partner sono emesse a mano. Compili il modulo qui sotto — oppure ci scriva via email, che raggiunge le stesse persone — e noi predisponiamo la credenziale e la inviamo al contatto che indica.
Ogni richiesta viene letta da una persona, perché una chiave dà accesso ai registri di conformità di un ristorante e il ristorante deve avere dato il proprio consenso. Quello che le costa è una risposta anziché un reindirizzamento; quello che ottiene è che nessuno possa coniarsi da solo l'accesso ai dati di qualcun altro. Il modulo chiede tutto ciò che ci serve per agire in una sola volta.
Chi può richiederla
Entrambe le parti, ma in ogni caso il ristorante deve dare il consenso.
- Lei, l'integratore. Indichi di quali ristoranti ha bisogno e il nome del suo referente presso di loro; confermiamo con loro prima di emettere qualsiasi cosa.
- Il ristorante. Richiede per suo conto e la indica. È il percorso più rapido, perché la conferma è già avvenuta.
Non emettiamo una chiave per un ristorante che non ha dato il consenso, e non ampliamo una chiave esistente senza chiederglielo di nuovo.
Richiedere una chiave
Se sta integrando per più ristoranti che appartengono a clienti diversi, invii una richiesta per cliente. Una chiave per cliente evita che una revoca faccia cadere tutte le altre integrazioni che gestisce.
Due dei campi meritano una nota. L'ambiente conta perché chiavi e dati sono per ambiente — una chiave di produzione non significa nulla in pre-produzione, quindi ci dica se vuole sviluppare prima contro la pre-produzione. E gli ambiti dovrebbero essere quelli che usa, non tutti: sono ventisei, uno per collezione più le consegne e le loro fotografie, e il ristorante legge quell'elenco prima di dare il proprio consenso. Indicare i quattro che le servono ottiene un sì più rapido che chiederli tutti; veda Autenticazione per cosa apre ciascuno.
Ha già una chiave e vuole una collezione che non raggiunge? È la stessa email, ed è un'estensione anziché una chiave nuova: il suo secret non cambia e non serve ridistribuire nulla.
Preferisce scriverla lei? contact@backresto.com con gli stessi dettagli raggiunge la stessa casella.
Cosa si riceve
Un unico valore, nella forma brp_<prefix>.<secret>, inviato al contatto
tecnico che ha indicato.
La conservi appena arriva ed elimini l'email. Conserviamo solo il prefisso pubblico e un digest del secret, quindi non possiamo reinviarla — se va persa revochiamo quella chiave e ne emettiamo una nuova, il che significa un altro giro.
Le chiavi non scadono da sole. Restano valide finché non vengono revocate, ed è per questo che la risposta a «qualcuno ha lasciato il team» è una rotazione, non un'alzata di spalle.
Modificare una chiave in seguito
Per tutte queste cose basta una email, e tutte richiedono il consenso del ristorante quando ampliano l'accesso:
| Richiesta | Cosa succede |
|---|---|
| Aggiungere un ristorante o un ambito | Estendiamo la chiave esistente. Il suo secret non cambia e non serve ridistribuire nulla. |
| Ruotare | Prima emettiamo una seconda chiave, lei la distribuisce, poi revochiamo la vecchia. Nessuna finestra in cui non funziona né l'una né l'altra. |
| Revocare | Immediato. La richiesta successiva con quella chiave risponde 401. |
| Una chiave a tempo | Lo indichi nella richiesta — per un audit una tantum o una prova di concetto, una chiave che muore da sola è più sicura di una che deve ricordarsi di eliminare. |
Per qualsiasi urgenza — soprattutto un secret trapelato — scriva a
contact@backresto.com
indicando il prefisso pubblico della chiave (la metà brp_… prima del
punto) e dicendo che è urgente. Non ci mandi mai il secret stesso, nemmeno per
dimostrare di quale chiave si tratta.
Nel frattempo
Niente nella documentazione richiede una chiave per essere letto, e le strutture sono tutte su queste pagine: il record di consegna, le fotografie, collezioni e record, il modello di errore e la paginazione. Anche il documento OpenAPI è pubblico, quindi può generare un client e scrivere il codice prima che arrivi la chiave.