Se stai costruendo un'app che si connette a Omnisend, segui i passaggi qui sotto per comprendere l'API, scegliere un metodo di autenticazione, completare la tua integrazione e inviarla per revisione.
🔡 Questo articolo si concentra sul percorso del partner.Per dettagli sull'implementazione, utilizza la documentazione API di Omnisend.
Prima di iniziare
Definisci cosa farà la tua app con i dati di Omnisend.Ad esempio, la tua app potrebbe:
Sincronizzare i contatti.
Recuperare i prodotti.
Inviare eventi che attivano flussi automatizzati.
Omnisend è una piattaforma self-service.Non è necessario richiedere un account sandbox separato per lo sviluppo o il testing.
Crea un normale account Omnisend e utilizza dati di test mentre sviluppi la tua integrazione.Puoi creare un account attraverso il processo di registrazione standard di Omnisend.
Processo di invio
Passaggio 1. Esamina la documentazione API di Omnisend
Inizia con Crea la tua app.Questa guida spiega come sono strutturate le app di Omnisend e quali passaggi sono richiesti.
Successivamente, rivedi la Guida rapida.Copre i fondamenti dell'API di cui hai bisogno per lo sviluppo, inclusi autenticazione, endpoint e formati di richiesta.
Identifica le risorse API di cui la tua app ha bisogno:
Utilizza la Contacts API se la tua app sincronizza i dati dei contatti.
Utilizza la Events API se la tua app invia eventi o attiva flussi automatizzati.
Utilizza la documentazione sul tracciamento degli eventi se la tua integrazione ha bisogno di dati sul comportamento del sito web, come visualizzazioni di pagina, visualizzazioni di prodotto o aggiunte al carrello.
Prima di continuare, documenta:
Cosa invierà la tua app a Omnisend.
Cosa recupererà la tua app.
Quali permessi sono necessari.
Cosa dovrebbe succedere quando una richiesta fallisce.
Passo 2. Scegli un metodo di autenticazione
Scegli tra una chiave API e OAuth in base a come gli utenti si connetteranno alla tua app.
🔡 Per un'app pubblica a cui si connetteranno più commercianti, Omnisend consiglia OAuth.OAuth fornisce a ciascun utente un flusso di autorizzazione invece di richiedere loro di creare e condividere manualmente una chiave API.
Per implementare OAuth, segui le istruzioni per l'autenticazione OAuth.Quindi, invia il modulo di richiesta delle credenziali OAuth.
Fornisci le informazioni richieste nel modulo.Omnisend fornirà le credenziali e le informazioni di cui hai bisogno per continuare.
Passaggio 3. Costruisci e testa la tua integrazione.
Costruisci e testa la tua integrazione con un normale account Omnisend.Utilizza dati di test e rivedi i risultati in Impostazioni del negozio → Log API.Utilizza i log API per eseguire il debug delle richieste e confermare che i dati vengano trasmessi correttamente.
Testa l'esperienza utente completa, inclusi:
Autorizzazione.
Sincronizzazione dei dati.
Richieste fallite.
Disconnessione.
Riconnessione.
Se la tua app invia contatti, ordini, prodotti, carrelli o eventi, verifica che ogni risorsa si comporti come descritto nell'elenco del tuo mercato delle app.
Passaggio 4. Invia la tua app completata
Dopo aver implementato e testato la tua integrazione, completa il modulo di invio del mercato delle app.
Includi le informazioni richieste nel modulo, come:
Nome dell'app.
Descrizione dell'app.
Categoria.
Sito web.
Logo.
Istruzioni di configurazione.
Contatto per il supporto.
Metodo di autenticazione.
Permessi richiesti.
Informazioni sui test.
Se il modulo richiede screenshot, credenziali di test, informazioni sulla privacy o dettagli di sicurezza, forniscili con la tua sottomissione.Questo aiuta Omnisend a testare la tua app.
Passo 5. Comprendere il processo di revisione
Dopo aver inviato il modulo, Omnisend esamina la tua integrazione e l'elenco proposto per il mercato delle app.
La revisione verifica se:
L'app funziona come descritto.
L'app utilizza i permessi richiesti in modo appropriato.
L'elenco fornisce istruzioni chiare per la configurazione.
Omnisend può contattarti se mancano informazioni o se la tua integrazione richiede modifiche.
Se vengono richieste modifiche, aggiorna l'app o l'elenco secondo le istruzioni del team di revisione.
Dopo che l'integrazione supera la revisione:
Omnisend può approvare e pubblicare l'elenco nel mercato delle app.Gli utenti possono quindi sfogliare l'elenco e connettere l'app.
Omnisend scrive anche un articolo di supporto dedicato che spiega come i commercianti possono integrare la tua app con Omnisend.
Passo 6. Mantieni la tua app dopo la pubblicazione
Tieni la tua integrazione aggiornata dopo la pubblicazione.Rivedi i tuoi permessi prima di rilasciare modifiche importanti e mantieni aggiornate le informazioni di contatto per il supporto.
Se prevedi di migliorare l'integrazione, fai sapere a Omnisend in modo che il contenuto di supporto correlato possa essere aggiornato.
Domande frequenti
Dovrei usare una chiave API o OAuth?
Scegli il metodo di autenticazione in base a come gli utenti si connetteranno alla tua app.OAuth è raccomandato per app pubbliche che saranno utilizzate da più utenti.
Quali informazioni dovrei includere nella mia sottomissione per il mercato delle app?
Fornisci le informazioni richieste nel modulo di sottomissione, inclusi il nome della tua app, la descrizione, la categoria, il sito web, il logo, le istruzioni per la configurazione, il contatto per il supporto, il metodo di autenticazione, i permessi richiesti e le informazioni sui test.
Hai bisogno di aiuto con Omnisend? Contatta il nostro team di supporto tramite la chat in-app o email[email protected]. Il nostro team è disponibile 24 ore su 24, 7 giorni su 7.