Appearance
Primi passi
Come iniziare a usare BASE9, dal punto di vista di chi pianifica l'integrazione.
1. Definire lo scopo dell'integrazione
Prima di tutto, chiarire cosa deve fare il sistema del partner con BASE9. Domande utili:
- Deve solo leggere dati (es. mostrare clienti e contratti) o anche scriverli?
- Quali entità coinvolge: clienti? punti di fornitura? contratti? agenti?
- Servono accessi personali per agenti/clienti (Area riservata) oltre all'integrazione di sistema?
Le risposte determinano il tipo di accesso e i permessi da richiedere (vedi Accessi).
2. Ottenere l'accesso
- Per l'integrazione tra sistemi: richiedere una Chiave API per il proprio ambiente, con il livello di permessi adeguato (sola lettura o lettura e scrittura).
- Per gli accessi personali: si abilitano in seguito, su invito, dal proprio ambiente.
3. Conoscere gli indirizzi del servizio
BASE9 espone indirizzi dedicati per ciascun canale:
| Canale | Indirizzo | Uso |
|---|---|---|
| Integrazione via Chiave API | api.base9.app | Sistemi del partner |
| Area riservata (persone) | api.base9.app | Login agenti/clienti |
| Documentazione | docs.base9.app | Manuale + API Reference |
Gli indirizzi e i parametri esatti per gli sviluppatori sono nell'API Reference.
4. Provare in autonomia
L'API Reference include una funzione "prova" (try-it-out): permette di eseguire chiamate reali dal browser, utile per verificare l'accesso e capire le risposte prima di scrivere codice.
5. Pianificare con gli sviluppatori
Una volta chiari scopo, accesso e indirizzi, il referente passa allo sviluppatore:
- la Chiave API (in modo sicuro),
- il link all'API Reference per il dettaglio delle operazioni,
- l'elenco delle attività da automatizzare (vedi le Guide operative).
Risultato atteso
Il partner ha un ambiente attivo, un accesso configurato e una visione chiara di quali funzioni integrare e in che ordine.

