Autenticazione API

Accedi alle API di CommerceClarity tramite Bearer Token

Le API di CommerceClarity utilizzano l'autenticazione Bearer Token per proteggere gli endpoint e garantire che solo i client autorizzati possano accedere ai dati. Ogni richiesta API deve includere un token di accesso valido nell'header HTTP.

Ottenere un Token API

Attualmente, i token API vengono forniti direttamente dal team di supporto di CommerceClarity. Per richiedere un token di accesso, compila il modulo di supporto disponibile a questo link fornendo il nome della tua organizzazione e la richiesta del token api nella descrizione.

Utilizzare il Token

Per autenticare le tue richieste API, includi il token nel header Authorization di ogni richiesta HTTP usando il formato Bearer <token>.

Formato dell'Header
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Esempi di Richieste API

Esempio cURL
curl -X GET "https://api.commerceclarity.io/products/list" \
     -H "Authorization: Bearer IL_TUO_TOKEN_API" \
     -H "Accept: application/json"
Esempio PHP (Guzzle)
<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;

$client = new Client([
    'base_uri' => 'https://api.commerceclarity.io',
    'timeout'  => 10.0,
    'headers' => [
        'Authorization' => 'Bearer IL_TUO_TOKEN_API',
        'Accept' => 'application/json',
    ]
]);

try {
    $response = $client->get('/products/list');
    $data = json_decode($response->getBody()->getContents(), true);
    
    // Elabora i dati
    
} catch (RequestException $e) {
    if ($e->hasResponse()) {
        $errorResponse = json_decode($e->getResponse()->getBody()->getContents(), true);
        // Gestisci l'errore...
    }
}
Esempio JavaScript (Fetch)
const apiUrl = 'https://api.commerceclarity.io/products/list';
const token = 'IL_TUO_TOKEN_API';

fetch(apiUrl, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Accept': 'application/json'
  }
})
.then(response => {
  if (!response.ok) {
    throw new Error(`Status: ${response.status}`);
  }
  return response.json();
})
.then(data => {
  console.log('Dati ricevuti:', data);
  // Elabora i dati
})
.catch(error => {
  console.error('Errore durante la richiesta API:', error);
});
Esempio Python (Requests)
import requests

api_url = 'https://api.commerceclarity.io/products/list'
token = 'IL_TUO_TOKEN_API'

headers = {
    'Authorization': f'Bearer {token}',
    'Accept': 'application/json'
}

try:
    response = requests.get(api_url, headers=headers)
    response.raise_for_status()  # Solleva un'eccezione per risposte HTTP 4XX/5XX
    
    data = response.json()
    
    # Elabora i dati
    
except requests.exceptions.HTTPError as err:
    print(f'Errore HTTP: {err}')
    if response.text:
        error_data = response.json()
        print(f'Messaggio di errore: {error_data.get("message", "Nessun messaggio")}')
except requests.exceptions.RequestException as err:
    print(f'Errore durante la richiesta: {err}')

Errori di Autenticazione

Se il token è mancante o non valido la richiesta API riceverà una risposta di errore 401 Unauthorized.

Esempio di Risposta per Errore di Autenticazione
{
  "status": "error",
  "message": "Unauthenticated."
}

Sicurezza del Token

Protezione del Token API

Il tuo token API fornisce accesso completo al tuo account CommerceClarity. Per proteggere i tuoi dati:

  • Tratta il token come una password - non condividerlo con terze parti non autorizzate
  • Non includere mai il token direttamente nel codice sorgente pubblico o nei repository
  • Utilizza variabili d'ambiente o sistemi di gestione dei segreti per memorizzare il token
  • Revoca immediatamente il token compromesso contattando il supporto

Best Practices

Sicurezza delle Comunicazioni

Utilizza sempre HTTPS per le richieste API per garantire che il token e tutti i dati trasmessi siano crittografati durante il transito.

Token nei Client Frontend

Evita di includere i token API nelle applicazioni frontend JavaScript accessibili pubblicamente. Utilizza invece un server backend per effettuare le richieste API.

Risoluzione dei Problemi

Problema Possibile Causa Soluzione
"Unauthenticated" o errore 401 Token mancante o non valido Verifica che il token sia correttamente formattato e incluso nell'header <code>Authorization</code>
Il token funziona per alcuni endpoint ma non per altri Il token potrebbe avere permessi limitati o specifici Verifica la documentazione per requisiti specifici di autenticazione per gli endpoint in questione

Passaggi Successivi

Endpoint Analisi Prodotti

Aggiungi nuovi prodotti al tuo inventario per poterne recuperare i dettagli.

Vai ad Analisi Prodotti
Dettagli Prodotto

Verifica lo stato attuale di un prodotto specifico nel tuo inventario.

Vai a Dettagli Prodotto
Stato Prodotto

Gestisci lo stato di pubblicazione dei tuoi prodotti.

Vai a Stato Prodotto

Assistenza

Supporto Tecnico

Se hai domande o riscontri problemi con le API, il nostro team di supporto è a tua disposizione. Compila il modulo di supporto disponibile a questo link includendo dettagli sulla richiesta e qualsiasi messaggio di errore ricevuto.