Guide del prodotto

Chiavi API

Per usare l'API di Wbiztool, o un'integrazione che ti chiede le credenziali, ti servono tre elementi dalla dashboard:

Credenziale	Campo API	Dove trovarla
API Client ID	`client_id`	Impostazioni → Chiavi API, in cima alla pagina
Chiave API	`api_key`	Impostazioni → Chiavi API
WhatsApp Client ID	`whatsapp_client`	La colonna ID Client WhatsApp in Impostazioni WhatsApp

Prima di iniziare#

Devi essere Amministratore dello spazio di lavoro per vedere, creare o eliminare chiavi API. Vedi Ruoli e autorizzazioni.
Seleziona prima lo spazio di lavoro giusto. Le chiavi appartengono allo spazio di lavoro selezionato quando le crei, e le richieste API effettuate con una chiave agiscono su quello spazio di lavoro. Vedi Cambiare spazio di lavoro.
Gli account demo non possono usare l'API.

Trovare il tuo API Client ID#

Apri Impostazioni → Chiavi API. La scheda Panoramica API mostra ID Client API: seguito da un numero. Usa questo numero come client_id in ogni richiesta. È lo stesso per tutte le chiavi dello spazio di lavoro.

Creare una chiave API#

Apri Chiavi API
Vai su Impostazioni e fai clic sulla scheda Chiavi API, oppure apri direttamente /settings/#api-keys.
Crea la chiave
In Nuova Chiave API, fai clic su Crea Nuovo. Un messaggio di conferma indica che la chiave è stata generata, e la chiave compare nella tabella.
Copia la chiave completa
La colonna Chiave API mostra solo l'inizio e la fine di ogni chiave. Fai clic sul pulsante di copia accanto (Copia Chiave API Completa) per copiare la chiave completa, poi incollala nella tua app o integrazione.

Le chiavi ricevono un nome automatico in base a quante chiavi ha lo spazio di lavoro (API Key 1, API Key 2 e così via) e non possono essere rinominate. Dopo che elimini una chiave, una nuova chiave può ricevere lo stesso nome di una esistente, quindi distingui le chiavi dai primi e ultimi caratteri e dalla data Creato. Le chiavi non scadono: una chiave funziona finché non la elimini.

Limite#

Uno spazio di lavoro può avere fino a 10 chiavi API alla volta. Quando raggiungi il limite, vedi "You have reached the maximum limit of 10 API keys per organization." (hai raggiunto il limite massimo di 10 chiavi API per organizzazione). Elimina una chiave che non usi più per crearne una nuova.

La tabella delle chiavi API#

Colonna	Significato
Etichetta	Il nome della chiave, ad esempio API Key 1.
Chiave API	I primi e gli ultimi caratteri della chiave. Usa il pulsante di copia per la chiave completa.
Creato	La data di creazione della chiave.
Stato	Sempre Attivo. Le chiavi eliminate vengono rimosse dalla tabella.
Azioni	Elimina rimuove la chiave.

Eliminare una chiave API#

Trova la chiave
In Impostazioni → Chiavi API, trova la chiave nella tabella.
Eliminala
Fai clic su Elimina, poi su Sì, Elimina Chiave API.

L'eliminazione di una chiave non può essere annullata. Ogni app che la usa ancora smette subito di funzionare e riceve Auth Error: invalid api key. Aggiorna prima le tue app con una nuova chiave.

WhatsApp Client ID#

Ogni numero WhatsApp collegato ha il proprio ID. La maggior parte degli endpoint di messaggistica lo richiede nel campo whatsapp_client per scegliere quale numero invia il messaggio.

Apri Impostazioni WhatsApp e leggi la colonna ID Client WhatsApp accanto a ogni numero. Vedi Collegare il tuo numero WhatsApp se non ne hai ancora collegato uno.

Verificare le credenziali#

Chiama Verifica credenziali (POST /api/v1/me/) con il tuo client_id e la tua api_key, e facoltativamente un whatsapp_client. Conferma che funzionano insieme senza inviare nulla e senza consumare messaggi. Se il whatsapp_client non appartiene allo spazio di lavoro, la risposta è Invalid WhatsApp Client ID.

Se una chiave API viene divulgata#

Chiunque abbia la tua chiave API e il tuo API Client ID può inviare messaggi dai tuoi numeri WhatsApp e consumare i messaggi del tuo spazio di lavoro.

Crea una chiave sostitutiva
In Impostazioni → Chiavi API, fai clic su Crea Nuovo e copia la nuova chiave.
Aggiorna le tue app
Sostituisci la vecchia chiave in tutte le app e le integrazioni che la usavano.
Elimina la chiave divulgata
Fai clic su Elimina accanto alla chiave divulgata. Smette subito di funzionare.
Controlla eventuali abusi
Esamina i messaggi recenti nei Report per individuare qualsiasi messaggio che non hai inviato tu.

Tratta come riservata anche l'email "WbizTool Alert - WhatsApp Connected Successfully!": viene inviata al creatore dello spazio di lavoro quando un numero si collega per la prima volta e può contenere una delle tue chiavi API.

Risoluzione dei problemi#

Problema	Cosa controllare
La scheda Chiavi API mostra Nessuna Chiave API Trovata, ma esistono delle chiavi	Non sei Amministratore in questo spazio di lavoro, oppure è selezionato un altro spazio di lavoro.
"You don't have permission to create API keys in this space."	Solo gli Amministratori possono creare o eliminare chiavi. Il pulsante Genera Nuova Chiave API in una tabella vuota compare per tutti, ma funziona solo per gli Amministratori.
"You have reached the maximum limit of 10 API keys per organization."	Elimina una chiave che non usi più.
`Auth Error: invalid api key`	La chiave è stata eliminata o digitata male, oppure il `client_id` non appartiene allo stesso spazio di lavoro della chiave. Se anche una nuova chiave e l'ID Client API mostrato nella pagina non funzionano, contatta l'assistenza (gli spazi di lavoro meno recenti possono mostrare un API Client ID che funziona solo con le chiavi create dal creatore dello spazio di lavoro).
`Auth Error - Please send correct API key and Client id`	Nella richiesta manca `api_key`.
`Invalid client id.` (oppure `Invalid Client Id` su alcuni endpoint)	`client_id` manca o non è un numero. In Verifica credenziali, se mancano `client_id` o `api_key` viene restituito solo `Auth Error`; lì `Invalid Client Id` significa che non è un numero. Copialo dalla scheda Panoramica API.
Le richieste agiscono sullo spazio di lavoro sbagliato	La chiave è stata creata in un altro spazio di lavoro. Cambia spazio di lavoro e crea lì una chiave.
`Demo Account can not access apis`	Gli account demo non possono usare l'API. Registrati per un account gratuito.