Autenticazione

L'API utilizza chiavi API segrete. Ogni chiave appartiene a uno spazio di lavoro.

Invia la chiaveCollegamento a questa sezione#

Inserisci la chiave nell'intestazione Authorization come token di accesso:

GET /api/v1/workspace HTTP/1.1
Host: tradecatalog.app
Authorization: Bearer tc_live_Xk2…

curl https://tradecatalog.app/api/v1/workspace \
  -H "Authorization: Bearer $TRADECATALOG_API_KEY"

Le chiavi iniziano sempre con tc_live_. Non esistono chiavi di prova: prova le cose su uno spazio di lavoro con dati di esempio, o leggi prima di scrivere.

Crea una chiaveCollegamento a questa sezione#

Solo il proprietario dello spazio di lavoro o un amministratore può creare chiavi, in Impostazioni → API.

La chiave viene mostrata una sola volta. Conserviamo solo un hash SHA-256, quindi nessuno di TradeCatalog può vederla di nuovo. Le Impostazioni mostrano i primi caratteri (come tc_live_Xk2m…) per poter distinguere le chiavi.

Uno spazio di lavoro può avere fino a 20 chiavi attive. Assegna a ogni sistema la propria chiave, in modo da poter revocare una senza danneggiare le altre.

Chi può avere chiaviCollegamento a questa sezione#

Lo spazio di lavoro ha bisogno di una di queste per creare chiavi:

• una sottoscrizione attiva
• un trial Pro
• un account di prova (organizzato con Happy Webs)

Le aree di lavoro di demo non possono creare o utilizzare chiavi.

Se la sottoscrizione scade, hai 14 giorni di grazia. Dopo questo periodo, l'area di lavoro torna a Free. Le chiavi esistenti possono ancora leggere, ma le scritture API falliscono con 403 read_only fino a quando Pro non è nuovamente attivo. Le modifiche al catalogo e gli ordini degli acquirenti nell'app continuano a funzionare.

Cosa può fare una chiaveCollegamento a questa sezione#

Una chiave agisce con le autorizzazioni della persona che l'ha creata, come sono attualmente. Una chiave creata da un proprietario o un amministratore può leggere ogni cliente, ogni prezzo del cliente, ogni ordine e il registro delle attività. Trattala come la password di quella persona. Una chiave creata da qualcuno limitato ai propri clienti o aree vede solo quei clienti e i loro ordini, prezzi e attività; qualsiasi altro cliente o ordine restituisce 404, lo stesso di uno che non esiste, e i cambiamenti dei prezzi restituiscono 403.

Se quella persona riceve successivamente un ruolo più ristretto, la chiave si restringe con loro: una scrittura che il nuovo ruolo non permette fallisce con 403 forbidden, lo stesso dell'app. Se lasciano l'area di lavoro, la chiave smette di funzionare con 401 key_owner_removed. Crea una nuova chiave da qualcuno che ha ancora accesso.

Ultima utilizzazione e revocaCollegamento a questa sezione#

Impostazioni mostra quando ogni chiave è stata utilizzata l'ultima volta (aggiornato al massimo una volta all'ora). Scegli Revoca per bloccare immediatamente una chiave. La prossima richiesta con essa otterrà 401 unauthorized. Le chiavi revocate non possono essere ripristinate.

Chi sono le modifiche registrateCollegamento a questa sezione#

Le scritture appaiono nel registro delle attività dell'area di lavoro come API key “Sage stock sync”. I cambiamenti dello stato degli ordini vengono registrati contro la persona che ha creato la chiave.

Mantieni le chiavi al sicuroCollegamento a questa sezione#

• Mantieni le chiavi sul tuo server, nelle variabili d'ambiente o in un gestore delle credenziali.
• Non inserire mai una chiave in una pagina web, un'estensione del browser o un'app mobile. L'API non permette richieste del browser (CORS) per questo motivo.
• Non committare mai una chiave in git. Se lo fai, revocala e crea una nuova.
• Usa una chiave di sola lettura ovunque tu abbia bisogno solo di leggere.

ErroriCollegamento a questa sezione#

Vedi Errori per l'elenco completo.