Registra la tua app

Sei uno sviluppatore?

Se non sei uno sviluppatore software, non creare un'app. Se non sei uno sviluppatore e qualcuno ti chiede di creare un'app, dovrebbe rivedere il proprio flusso di autenticazione. Se hai già creato un'app, mantieni privato il suo Client Secret.

Per iniziare a usare l'API, hai bisogno di un'app con cui interagire. Ottenere le credenziali per autenticare le tue richieste è fondamentale. Puoi creare e gestire le app sul sito dell'App Store. Puoi raggiungere lo store anche dall'applicazione Amica facendo clic su App Store nel menu utente (angolo in alto a destra della pagina).

Per creare una nuova app, premi il pulsante Nuova.

Non vedi il pulsante Nuova?

Se non vedi il pulsante, probabilmente non hai effettuato l'accesso. Seleziona Login nel menu principale e procedi con l'accesso. Se hai effettuato l'accesso e non vedi il pulsante Nuova, il tuo utente non è un Amministratore. Solo gli utenti amministratori possono creare app, quindi accedi con un account amministratore e riprova (il primo account creato con il tuo abbonamento è un utente amministratore).

Configurazione

Durante la creazione dell'app è necessario compilare diversi campi e fare alcune scelte importanti. Ecco una panoramica dei campi e del loro significato.

Campo	Descrizione
Nome	Nome dell'applicazione.
Descrizione	Descrizione. La ricerca viene effettuata su questo campo e sul campo Nome qui sopra, quindi assicurati che il contenuto di questo campo sia ben curato.
Sito web	Homepage dell'applicazione. Dovrebbe essere un sito web autorevole che confermi l'autore dell'app e lo scopo dell'app. Viene verificato prima dell'attivazione dell'app.
Logo	Logo dell'applicazione. Si tratta di un URL a un logo da 512px x 512px che verrà visualizzato insieme al nome dell'applicazione, se presente.
Email	Email dell'autore. È l'indirizzo email che l'utente utilizzerà per mettersi in contatto con l'autore dell'app, sia per supporto sia per altri motivi di contatto. Viene verificato prima dell'attivazione.
Amministratore	Indica se l'utente deve disporre di un accesso amministratore per essere ammesso all'applicazione.
Pubblica	Indica se l'applicazione è pubblica o privata. Le app sono private per impostazione predefinita. Vedi Visibilità dell'app qui sotto per maggiori informazioni.
Scope	Scope API richiesti dall'applicazione. Vedi Scope per maggiori informazioni.
Autenticazione	Flusso di autenticazione per l'app. Vedi Autenticazione e autorizzazione per l'elenco dei flussi disponibili.
URL di ritorno	URL di ritorno a cui l'utente deve essere reindirizzato dopo un accesso riuscito. Obbligatorio se è stato selezionato Code come flusso di autenticazione. Vedi Authorization Code con PKCE per maggiori informazioni.

Credenziali del client

Una volta creata la tua app, le sue credenziali vengono mostrate nella pagina.

Campo	Descrizione
Client ID	L'identificativo univoco del tuo client. Pur non essendo intrinsecamente segreto, non dovresti aver bisogno di condividere l'ID, ed è nel tuo interesse mantenerlo riservato.
Client Secret	Il segreto del tuo client (immaginalo come una password). Non dovrebbe mai essere condiviso con nessuno.

Il Client ID e il Client Secret costituiscono le credenziali del tuo client e dovrebbero essere immediatamente conservati in un luogo sicuro. Queste credenziali sono di fondamentale importanza. Ad esempio, nell'Authorization Code con PKCE, scambierai le credenziali del client con un Authorization Code, che il tuo client utilizzerà poi per ottenere un Access Token valido (vedi Autenticazione e autorizzazione per maggiori dettagli).

Ricorda: mentre il Client ID può essere recuperato in seguito tramite l'App Store, il Client Secret verrà mostrato solo qui, in questa pagina, dopo la creazione riuscita dell'app. Se dovessi perderlo, perderai in modo permanente l'accesso alla tua applicazione.

CONSERVA IL CLIENT SECRET IN MODO SICURO

Il Client Secret deve essere sempre conservato in un luogo sicuro, come una variabile d'ambiente. È fondamentale tenerlo lontano dalla vista pubblica, quindi non pubblicarlo mai sul tuo front end. Ricorda inoltre: se dovessi perderlo, perderai in modo permanente l'accesso alla tua applicazione.

NON CONDIVIDERE MAI IL CLIENT SECRET

Il Client Secret, utilizzato nel flusso OAuth 2.0, non deve MAI essere condiviso con applicazioni di terze parti! Se qualcuno ti chiede di passargli il Client Secret, deve aver fatto qualcosa di sbagliato. Inviagli il link a questa pagina ed elimina la tua app se hai già condiviso il Client Secret.

Processo di approvazione

Le app pubbliche e private sono soggette a una fase di verifica prima di essere abilitate nello store oppure rifiutate. Il processo di approvazione è solitamente più breve e richiede meno comunicazioni per le app private, mentre può essere più lungo e comportare scambi prolungati via email e, occasionalmente, telefonici con il nostro team. Leggi la sezione Visibilità dell'app qui sotto per i dettagli sul processo.

Visibilità dell'app

La visibilità dell'app descrive l'insieme di utenti che possono utilizzare la tua nuova applicazione. Sono disponibili due opzioni:

• App private
• App pubbliche

Le app non sono immediatamente disponibili agli utenti

Non allarmarti se la tua app appena creata non appare nell'App Store. Le nuove app non saranno immediatamente disponibili agli utenti. Sia le app pubbliche sia quelle private resteranno disattivate finché il team di supporto Amica non le approva. Questo periodo di verifica può durare da poche ore a diversi giorni, con le app pubbliche che richiedono un processo più lungo rispetto a quelle private.

App private

Le app private sono la scelta ideale nei seguenti scenari:

• Uso semplice dell'API per scopi di import/export sulla tua (o sulle tue) azienda
• Integrazione personalizzata con il tuo software gestionale, CRM o ERP
• Qualsiasi altro caso il cui utilizzo sia limitato al contesto della tua (o delle tue) azienda e non distribuito pubblicamente
• Sviluppare e testare privatamente una futura app pubblica

Le app private sono disponibili solo per gli account (utenti) che condividono l'abbonamento con l'autore dell'app. Gli altri utenti non vedranno nemmeno l'app elencata nello Store. Come le app pubbliche, anche quelle private sono soggette a verifica prima di essere abilitate, ma in genere la loro attivazione richiede meno tempo.

App pubbliche

Un'app pubblica può essere utilizzata da tutti gli utenti ed è sempre visibile nello Store, anche agli utenti anonimi. Il team di supporto Amica esamina attentamente le app pubbliche, assicurandosi che tutti i controlli di sicurezza e conformità siano superati. Questo processo di verifica comporterà uno scambio via email o telefonico.

Casi d'uso validi per queste app possono essere:

• Integrazione SaaS o nativa
• Integrazione e-commerce pubblica, quando sei tu lo sviluppatore dell'integrazione
• Qualsiasi altro caso il cui utilizzo sia pubblico e pensato per essere distribuito (ad esempio deve poter essere utilizzato da più utenti Amica non noti al momento dello sviluppo)

Casi d'uso non validi includono:

• Integrazione e-commerce pubblica (se sei utente di un plugin di terze parti e non l'autore originale dell'e-commerce)
• Tutti i casi d'uso elencati nella sezione App private
• Tutti i casi d'uso validi sopra elencati, se il codice non è ancora pronto per essere rilasciato in produzione (in questo caso, sospenderemo la tua richiesta finché non sarai pronto)

Possiamo rifiutare la tua richiesta se:

• Non rispondi alle nostre email entro qualche giorno
• La tua risposta alla nostra email è troppo concisa (in questo caso, chiederemo informazioni aggiuntive)
• Non riesci a spiegare il tuo caso d'uso in dettaglio
• Il tuo caso d'uso non è considerato idoneo alla pubblicazione dell'app (vedi gli elenchi sopra)