Company ID e multi-azienda
La maggior parte degli endpoint dell'Amica Cloud API è relativa a una specifica
azienda. Una stessa credenziale può però operare su più aziende: il
companyId indica su quale database aziendale agire.
Il pattern degli URL
Gli endpoint relativi a un'azienda seguono questo schema:
dove {companyId} è l'identificativo univoco del database aziendale. Per esempio,
per elencare gli articoli di magazzino dell'azienda 1:
Elencare le aziende disponibili
Per conoscere quali aziende sono accessibili con le credenziali in uso, interroga l'endpoint di configurazione:
La risposta contiene l'elenco delle aziende con i rispettivi identificativi, da usare
come {companyId} nelle chiamate successive. È in genere la prima chiamata che
un'integrazione effettua dopo essersi autenticata.
Tip
Nei Quickstart il primo passo di ogni esempio è proprio l'elenco delle aziende: è il modo più semplice per verificare che autenticazione e configurazione siano corrette.
Endpoint non legati a un'azienda
Alcuni endpoint, come config/Azienda, non sono relativi a una singola azienda e non
richiedono quindi il companyId nell'URL. La API Reference indica per ogni
endpoint se il companyId è richiesto.