API documenti

L'API IBM Blockchain Transparent Supply Documents consente agli utenti autorizzati di caricare, visualizzare e condividere i documenti della catena di fornitura della tua organizzazione, come i certificati della struttura e i report di verifica.

Prerequisiti

Per utilizzare IBM Blockchain Transparent Supply Documents API, devi soddisfare i seguenti requisiti:

  1. La tua organizzazione è sottoscritta a Documents.
  2. Gli esperti di integrazione dei dati hanno familiarità con l'utilizzo delle API REST per inviare i dati in modo programmatico. L'automazione del caricamento dei dati è un obiettivo finale per facilitare la condivisione dei dati.
  3. Affinché le organizzazioni IBM Blockchain Transparent Supply condividano i dati della catena di fornitura, ciascuna organizzazione deve aver definito il livello appropriato di controllo dell'accesso ai dati. Per i dettagli sulla limitazione e la condivisione dei propri dati, consultare Modalità titolarità dati e Controllo accesso dati.

Guida introduttiva

Attieniti alla seguente procedura per iniziare a utilizzare IBM Blockchain Transparent Supply Documents API:

  1. Ottenere un token di autenticazione, come descritto in Autenticazione.
  2. Inoltra una richiesta API Documenti includendo il token di autenticazione nell'intestazione di autorizzazione, come mostrato nella richiesta di esempio. Per il test manuale, gli utenti umani possono utilizzare Swagger per richiamare gli endpoint API.
  3. Per assistenza nella comprensione del modello di risposta API, fare riferimento alla documentazione nelle seguenti sezioni.

Swagger

Per utilizzare manualmente l'API Documents, utilizzare l'interfaccia Swagger per i seguenti ambienti:

Devi prima fornire un token di autorizzazione IBM Blockchain Transparent Supply valido (token utente umano) su Swagger, utilizzando il pulsante Authorize nella sezione in alto a destra della pagina.

Endpoint

Tutti gli endpoint API Documents sono documentati in API Documents. Con l'autorizzazione richiesta, gli utenti possono creare, condividere, ricercare, scaricare e visualizzare i documenti.

Ad esempio, per creare un nuovo documento, un utente autorizzato richiama i seguenti endpoint:

  • GET /templates/{documentType} - Richiama un modello di tipo di documento per il rendering e la convalida di un documento.
  • POST /documents - crea e carica un nuovo documento, con autorizzazioni di accesso.

Corpo della richiesta

Utilizza i seguenti attributi per creare e caricare un nuovo documento (endpointPOST /documents ):

  • properties - Informazioni sul documento (caricato in JSON).
  • content - un file di contenuto in formato PDF, PNG, JPEG o GIF.
  • entitlement - Permessi di accesso al documento. Per i dettagli, consultare Modalità titolarità dati e Controllo accesso dati .

Parametri

I seguenti parametri vengono utilizzati quando si richiamano gli endpoint applicabili:

  • id - l'ID documento generato dal sistema.
  • version - La versione del documento. Le versioni dello stesso documento hanno un idequivalente.

Query di esempio

Vedi API Documents per richieste e risposte di esempio per ogni endpoint.