Primi passi
Questo tutorial descrive come configurare il client dell'API On-Premises, registrare un numero di telefono aziendale, aggiornare le impostazioni e inviare un messaggio di prova.
La procedura per iniziare a usare l'API può essere suddivisa in 3 parti:
- Preparazione delle risorse: prima di iniziare, devi configurare le risorse necessarie per completare l'integrazione dell'API, compreso un account WhatsApp Business.
- Installazione del client dell'API On-Premises: installa il client dell'API. Quando il client è attivo, puoi aggiornare le impostazioni dell'applicazione.
- Uso del client: registra il numero di telefono con una chiamata API a
/accounte invia un messaggio di test con una chiamata a/messages.
Prima di iniziare
Hai bisogno di:
- Un account Business Manager di Facebook
- Una linea di credito per il tuo account WhatsApp Business. Puoi fare riferimento a Informazioni sulla fatturazione dell'API di WhatsApp Business per ulteriori informazioni sul processo di fatturazione.
- Uno strumento da riga di comando come Terminal o un'app come Postman in grado di eseguire richieste cURL.
Una volta completata la verifica dell'azienda, questa verrà sottoposta ad analisi per accertarne la conformità ai Termini di servizio di WhatsApp e alla Normativa commerciale di WhatsApp. Questo passaggio viene avviato automaticamente. Puoi controllare lo stato della verifica dell'azienda e dell'analisi dell'attività nella tab Impostazioni del tuo account WhatsApp Business in Business Manager. Una volta ricevute le approvazioni, la Verifica dell'azienda risulterà Verificata e lo Stato dell'account sarà Approvato.
Configurazione dell'account WhatsApp
Aggiungi un numero di telefono e il relativo nome visualizzato sul tuo account WhatsApp Business. Questa operazione determinerà l'invio del nome visualizzato per l'analisi.
Se desideri modificare il nome visualizzato, puoi farlo un numero illimitato di volte fino al completamento della registrazione; successivamente, dovrai attendere 30 giorni dopo ogni richiesta di modifica del nome visualizzato.
Una volta completate tutte le analisi, puoi visualizzare e accedere al tuo certificato con codifica base64, necessario per la registrazione del client dell'API di WhatsApp Business. Ti invitiamo a registrarti con un nome visualizzato approvato per iniziare l'integrazione, prima di apportare ulteriori modifiche a tale nome. Puoi modificare il nome visualizzato in qualsiasi momento dopo l'integrazione.
Analisi delle informazioni di fatturazione e sui prezzi
Dal momento in cui la tua azienda inizia a inviare messaggi tramite l'API di WhatsApp Business, è importante comprendere il processo di fatturazione, la modalità e la frequenza degli addebiti e il modo in cui visualizzare e pagare la fattura mensile. Per maggiori informazioni, consulta Informazioni sulla fatturazione per gli account WhatsApp Business. Per le regole di tariffazione e i costi per messaggio, consulta la nostra pagina sui prezzi.
Versioni software consigliate
| Software | Versione | Dettagli |
|---|---|---|
API On-Premises | ||
API On-Premises per AWS | Controlla il registro modifiche Versione modello: | |
MySQL |
| Tieni presente che un database migrato a MySQL 8 non può essere riportato a MySQL 5. Quindi, esegui un backup del database prima di procedere alla migrazione. |
PostgreSQL |
| Sono supportate le versioni |
Docker | Versione | La versione Assicurati che statx syscall sia nelle syscall consentite per il docker. |
Postman | Qualsiasi versione recente | |
libseccomp |
| È supportata solo la versione |
glibc |
| Sono supportate solo la versione |
Sistema operativo (OS) | La versione più recente | Usa almeno la versione del kernel minima |
Passaggio 1: installare il client dell'API On-Premises
Ambiente
La struttura principale del client dell'API On-Premises si basa su Docker. Consulta Architettura client per le informazioni su ciascun componente.
Attualmente, il client dell'API On-Premises non supporta Docker per Windows o per un sottosistema Windows per Linux. Per esigenze di sviluppo, l'utilizzo di una macchina virtuale Linux e l'esecuzione di Docker al suo interno è la soluzione consigliata. Per i carichi di lavoro di produzione, è consigliabile utilizzare un server Linux per evitare problemi di compatibilità e prestazioni.
Apparecchiatura
Il client dell'API On-Premises può essere eseguito su qualsiasi computer connesso a Internet che esegua Docker per Linux su macchina virtuale o server Linux. Per maggiori informazioni consulta le FAQ. Ad esempio, è possibile eseguire semplici test su un computer portatile. Per un server nell'ambiente di produzione, consigliamo SSD da almeno 250 GB, 16 GB di RAM e CPU 4 core. Non è consigliato l'uso dell'HDD in quanto le velocità di I/O subiscono un rallentamento sotto carico.
Nella maggior parte dei casi, è necessario eseguire il database su un server fisico separato dai contenitori Coreapp e Webapp. Tra il server di database e le macchine di calcolo dovrebbero intercorrere solo pochi millisecondi di latenza.
Installazione
Esistono due modi per iniziare a muovere i primi passi con l'API On-Premises:
- Installazione on-premise: puoi configurare autonomamente i contenitori Docker utilizzando la guida all'installazione. Ti consigliamo di iniziare con una delle configurazioni per sviluppatori per acquisire familiarità con il processo di configurazione e l'invio di messaggi. Questa soluzione on-premise può essere utilizzata sul computer prima della migrazione a un ambiente di produzione.
- Amazon Web Services (AWS): se utilizzi AWS o desideri una soluzione più autonoma, consulta la nostra guida ad AWS. L'alternativa AWS configura un'intera soluzione per l'API On-Premises con backup, ripristino e altro in un cloud AWS gestito e posseduto da te.
Una volta che il client dell'API On-Premises è in esecuzione, devi aver effettuato l'accesso come admin per eseguire il resto delle fasi di configurazione.
Aggiornamento delle impostazioni
Puoi apportare modifiche alle impostazioni dell'app quando il client dell'API On-Premises è in esecuzione. Tuttavia, non puoi accedere alle diverse impostazioni del profilo del tuo client dell'API On-Premises fino al completamento della registrazione.
- Le Impostazioni dell'app sono relative al funzionamento del client: impostazioni di callback, webhook, on-call pager, stato inviato, comportamento del download di contenuti multimediali, ecc. Nota: è fortemente consigliabile impostare un URL webhook per ricevere notifiche relative a messaggi o errori in entrata.
- Le Impostazioni del profilo aziendale e le Impostazioni del profilo sono relative a informazioni sulla tua attività, come indirizzo, e-mail, sito web, settore, sezione "Chi siamo" e foto del profilo.
Passaggio 2: iniziare a utilizzare il client
Registrazione
Quando il client dell'API On-Premises è attivo e in esecuzione, puoi registrare il numero di telefono inviando una chiamata API all'endpoint account.
Invio di un messaggio di prova
Puoi anche inviare messaggi di prova usando l'endpoint messages. In primo luogo, controlla lo stato del numero di telefono che intendi utilizzare per il test. Dovrai inviare un messaggio al tuo account WhatsApp dal numero di telefono di prova per abilitare la finestra Servizio clienti, che ti consente di inviare qualsiasi tipo di messaggio entro 24 ore (per i dettagli, vedi Controllo cut-off). Quindi, invia un SMS al numero di telefono di prova. Se il messaggio arriva significa che l'installazione è stata eseguita correttamente. Se non arriva, controlla se nel tuo webhook sono presenti notifiche che potrebbero indicare eventuali problemi.
Sicurezza
Consulta la nostra guida sulla Sicurezza per informazioni su password, autenticazione, configurazione SSL, segregazione delle reti, comunicazioni crittografate, intestazioni HTTP e sul protocollo TLS per server web in riferimento al client dell'API On-Premises.
Procedura di avvio
L'API WhatsApp On-Premises è sottoposta a una procedura di avvio per stabilire una connessione con il server. Questa procedura è fondamentale per garantire un mezzo affidabile e senza interruzioni per inviare e ricevere messaggi. Durante questa fase di avvio, l'applicazione principale (coreapp) attende il soddisfacimento di diversi prerequisiti, tra cui:
Caricamento dei modelli di messaggi: l'API carica i modelli dei messaggi dal server come parte del processo di inizializzazione.
Ricezione ed elaborazione di messaggi offline: gestisce anche la ricezione e l'elaborazione di messaggi offline.
Se vengono effettuati tentativi di inviare messaggi mentre questi prerequisiti non sono soddisfatti, l'applicazione principale risponderà con il messaggio di errore "Coreapp non pronto" e i registri mostreranno l'errore "Servizio non pronto". È importante notare che questa procedura di avvio viene eseguita ogni volta che viene stabilita una nuova connessione con il server WhatsApp. Di conseguenza, se l'applicazione principale viene riavviata o si verifica una disconnessione, la procedura di avvio viene avviata nuovamente per impostare lo stato del coreapp su "pronto". Questo garantisce l'affidabilità e la prontezza dell'API WhatsApp On-Premises per la comunicazione dei messaggi.
Elaborazione di messaggi offline
Quando non ci sono messaggi offline, la fase di elaborazione di tali messaggi viene omessa. In altre parole, se non ci sono messaggi in attesa in uno stato offline, questa particolare fase di gestione dei messaggi viene bypassata.
In condizioni tipiche, l'API WhatsApp On-Premises segue un protocollo standard per la gestione dei messaggi offline. Attende la ricezione e l'elaborazione di tutti i messaggi offline, con un timeout massimo predefinito di 6 minuti. Una volta trascorso questo periodo di 6 minuti, la fase di elaborazione dei messaggi offline è considerata completata correttamente.
Suggerimenti aggiuntivi
COSA FAREInizia lo scambio di messaggi prima con i dipendenti interni, così da verificare che il sistema funzioni. Rispondi a tutti i clienti entro 24 ore. Rispetta le nostre norme, delineate nella Normativa di WhatsApp Business e nella Normativa sulle vendite di WhatsApp. Utilizza più numeri di telefono per sviluppo, test e produzione. Controlla le FAQ prima di aprire un ticket per l'Assistenza diretta. Fornisci un feedback sul prodotto. L'Assistenza diretta è il miglior canale per farlo. | COSA NON FAREInviare notifiche duplicate a più canali. Inviare spam. Utilizzare numeri verdi per il test. Creare un Business Manager solo per le integrazioni di WhatsApp. Utilizzane uno esistente, se disponibile. |
Se rileviamo una violazione delle nostre linee guida o norme, ci riserviamo il diritto di limitare o rimuovere il tuo accesso a WhatsApp.