Introduzione alle API di CommerceClarity

Panoramica delle API CommerceClarity e della loro integrazione

Le API di CommerceClarity offrono un'interfaccia programmatica che consente di interagire con la piattaforma, automatizzare processi e integrare facilmente le funzionalità di CommerceClarity nelle vostre applicazioni e flussi di lavoro esistenti.

Questa documentazione è progettata per guidarvi attraverso tutte le funzionalità disponibili.

URL Base API
https://api.commerceclarity.io

Caratteristiche Principali

Autenticazione Sicura

Tutte le richieste API sono protette tramite autenticazione Bearer Token, garantendo che solo i client autorizzati possano accedere ai tuoi dati.

API RESTful

Le nostre API seguono i principi RESTful, utilizzando metodi HTTP standard e formati di risposta JSON per una facile integrazione con qualsiasi ambiente di sviluppo.

Sistema di Rate Limiting

Implementiamo limiti di frequenza ragionevoli per garantire prestazioni ottimali per tutti gli utenti. Gli endpoint critici sono ottimizzati per carichi elevati.

Formati Standardizzati

Tutte le risposte sono in formato JSON con strutture coerenti. Gli errori seguono schemi prevedibili per semplificare la gestione delle eccezioni.

Guida Rapida all'Uso

Esempio PHP (Guzzle) 
<?php

require 'vendor/autoload.php';

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

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

// Effettua una richiesta API
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';

// Effettua una richiesta 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'
}

# Effettua una richiesta API
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}')
Esempio cURL 
# Effettua una richiesta API
curl -X GET "https://api.commerceclarity.io/products/list" \
     -H "Authorization: Bearer IL_TUO_TOKEN_API" \
     -H "Accept: application/json"

Categorie di Endpoint

Categoria Descrizione Casi d'Uso
Prodotti Import e recupero prodotti Analisi, recupero dettagli, gestione stato

Flussi di Lavoro Comuni

  1. Analisi del prodotto: Utilizza POST /api/products/analyze fornendo codici EAN, ASIN o MINSAN per analizzare e arricchire i dati dei prodotti.
  2. Verifica lo stato: Monitora lo stato di elaborazione con GET /api/products/details/{id}.
  3. Gestione dell'inventario: Una volta completata l'analisi, puoi aggiornare lo stato di pubblicazione con PUT /api/inventories/set-publication-state.
L'analisi consumerà crediti in base ai servizi richiesti. Monitora il saldo dei crediti nella risposta API.

Versionamento API

Attualmente, tutte le API CommerceClarity si trovano nella versione stabile senza necessità di specificare esplicitamente la versione nell'URL.

Le eventuali future versioni verranno gestite attraverso header HTTP specifici o prefissi negli URL, mantenendo la retrocompatibilità per un periodo ragionevole.

Sistemi supportati

Le API di CommerceClarity sono progettate per essere utilizzate con qualsiasi linguaggio di programmazione o framework in grado di effettuare richieste HTTP. Forniamo esempi di codice per i seguenti linguaggi e framework:

PHP (Guzzle)
JavaScript (Fetch/Axios)
Python (Requests)
cURL

Passaggi Successivi

Autenticazione

Impara come autenticare le tue richieste API con token di accesso.

Vai all'Autenticazione
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

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.