Centro assistenzaIntegrazioni

Per: Amministratori

Autentica le richieste API con una chiave

Invia la tua chiave come token bearer all'API del pannello di amministrazione per una chiave di gestione o all'API del portale per una chiave hub, e limita l'invio ai tuoi indirizzi IP.

In questo articolo5 sezioni

Prima di iniziare

Questa pagina indica dove inviare ogni tipo di materiale. Chiave APIChiave Un token segreto, creato nella sezione Integrazione, che consente al tuo software di utilizzare l'API dell'hub., Come inviarlo… E perché un’operazione di trasmissione viene rifiutata.

Indirizzi

ChiaveIndirizzo baseEsempio
Gestire le informazioni chiavehttps://prd-api-manage.caseactive.com/v1/<hub id>/https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
Gestire le importazioni importanti.https://prd-api-manage.caseactive.com/v1/integration/<hub id>/https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports
Tasto per accedere al sistemahttps://prd-api-app.caseactive.com/v1/<hub id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
Tasto “Hub”, un caso particolare.https://prd-api-app.caseactive.com/v1/<hub id>/<case id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts

Il tuo ID di hub è… ca- E poi ci sono 14 caratteri in totale. Viene visualizzato come… ID hub sul/nel Panoramica Sulla pagina di ogni caso presente nel proprio portale, è presente un pulsante per effettuare una copia della pagina stessa. L’ID del caso è… cc- E 14 caratteri, indicati come… ID caso.

Invio della chiave

Invia la chiave nel campo Authorization di ogni chiamata, dopo Bearer e uno spazio.

curl https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles \
  -H "Authorization: Bearer YOUR_API_KEY"
  • Invia i corpi JSON utilizzando il formato Content-Type: application/json.
  • Una chiave non scade nel tempo. Funziona fino a quando un amministratore non la disattiva o la elimina nella sezione “Integration › Chiavi”.
  • Ogni segnale di chiamata viene ricalcolato: non c’è alcuna sessione o token da scambiare.
  • Le date e gli orari vengono indicati in formato UTC.

Limitare i luoghi in cui viene utilizzato

Sotto Fonte CIDR, è possibile limitare l’uso di una chiave API all’indirizzo IPv4 pubblico del proprio sistema, ad esempio 203.0.113.10. Inoltre, è possibile indicare un intervallo di indirizzi, ad esempio 203.0.113.0/24. L’API accetta soltanto connessioni basate sull’IPv4; quindi, l’uso di indirizzi o intervalli IPv6 viene rifiutato quando vengono salvati. Inoltre, eventuali tentativi di accesso da qualsiasi altro luogo verranno respinti con il messaggio 401 LoginSourceIpException. Per modificare l’intervallo di indirizzi, consultare la sezione Restringere o revocare una chiave API.

Quando una chiave viene rifiutata

Ogni rifiuto viene considerato come un errore, e i nomi message associati a tale errore vengono indicati come tali. Per ulteriori informazioni, vedere Gestione degli errori legati alle API e dei codici di stato.

StatomessagePerchéCosa fare
401UnauthorizedNessun messaggio è stato inviato, oppure il messaggio inviato non rappresenta in realtà un “chiave”.Verificare il header Authorization
401HostNotFoundExceptionL’ID del hub indicato nell’indirizzo non esiste.Copiare di nuovo ID hub.
401HostPurgingExceptionIl hub viene eliminato.Chiedete a un amministratore del vostro hub.
401SessionNotFoundExceptionLa chiave è stata eliminata, oppure appartiene a un altro hub.Utilizzare una chiave attuale per questo hub.
401LoginKeyInactiveExceptionLa chiave è spenta.Chiedete a un amministratore di attivare questa funzione.
401LoginKeyWrongApiExceptionUna chiave di gestione è stata inviata all’indirizzo della chiave di hub, oppure al contrario.Utilizzare l’indirizzo relativo al tipo di chiave.
401LoginSourceIpExceptionLa chiamata proveniva dall’esterno del raggio di azione della chiave.Chiama da un indirizzo autorizzato, oppure amplia l’ambito di utilizzo della chiamata.
401LoginSourceCidrExceptionIl range in cui è salvata la chiave non può essere letto.Corretto Fonte CIDR
403BotNotAllowedExceptionÈ possibile gestire una chiave che non può essere utilizzata.Vedi “Capire cosa può fare l’API”.
403ManageBillingInactiveExceptionIl pannello di amministrazione del tuo hub è bloccato dopo un tentativo di pagamento fallito. È possibile accedere al pannello soltanto utilizzando una chiave specifica.Chiedete a un amministratore di aggiornare il metodo di pagamento.
403BillingReadOnlyExceptionLa sottoscrizione del tuo hub è scaduta, e il suo portale è di tipo “solo lettura”. Quindi, una chiave hub può leggere i dati presenti nel portale, ma non può modificarli.Chiedete a un amministratore di riavviare la sottoscrizione.
403CaseClosedExceptionUna chiave di hub ha cercato di aprire un caso chiuso.Per prima cosa, bisogna riaprire il caso.
404CaseNotFoundExceptionUna chiave di hub indica un caso che non esiste, oppure che non si trova nel proprio hub.Verificare l’ID del caso.
503LoginSessionExceptionIl hub era troppo occupato per poter effettuare il controllo della chiave.Prova di nuovo tra poco.

Un 401 indica sempre che la chiave stessa è stata rifiutata. Quindi, la sincronizzazione può interrompersi e potrebbe allertare qualcuno. Gli altri errori riguardano invece il corso della chiamata.

Articoli correlati

Gestire gli errori e i codici di stato delle APILeggi il corpo dell'errore, cosa significano i codici 400, 401, 403, 404, 500 e 503 e perché un elemento che la tua chiave non riesce a vedere risponde al codice 404.IntegrazioniComprendere cosa può fare l'APIScopri quali funzioni possono svolgere un tasto di gestione e un tasto hub, perché ogni tasto funge da Assistente Virtuale e dove trovare l'elenco tecnico completo.IntegrazioniLimitare o revocare una chiave APILimita l'utilizzo di una chiave a determinati indirizzi IP, disattivala o eliminala e verifica quando è stata utilizzata l'ultima volta.Integrazioni · 2 min