Nozioni di base sulle API

Ultimo aggiornamento: 5 maggio 2025
  • Argomenti:

Creato per:

  • Sviluppatore

L’obiettivo per l’API di Adobe Workfront è semplificare la creazione di integrazioni con Workfront introducendo un’architettura REST-ful che funziona tramite HTTP. Questo documento presuppone che tu abbia familiarità con le risposte REST e JSON e descrive l’approccio adottato dall’API Workfront.

Acquisire familiarità con lo schema Workfront ti aiuterà a comprendere le relazioni tra database che possono essere utilizzate per estrarre dati da Workfront a scopo di integrazione.

Limiti e linee guida

Per garantire prestazioni coerenti del sistema Workfront on-demand, l’API Workfront limita i thread API simultanei. Questo guardrail impedisce i problemi di sistema causati da chiamate API abusive. L’ambiente Sandbox dispone dello stesso limite di thread API simultanei, che consente a clienti e partner di testare con precisione le chiamate API prima di rilasciare il codice in produzione.

Per gli ambienti di produzione, anteprima e test delle unità, le richieste degli utenti finali hanno una lunghezza URI massima di 8892 byte, in quanto vengono instradate tramite la rete CDN di Workfront (Akamai). Questo limite si applica solo agli URI instradati attraverso la rete CDN.

Esclusione di responsabilità

Qualsiasi utilizzo dell’API deve essere testato nell’ambiente beta di Workfront prima di essere eseguito nell’ambiente di produzione. Se un cliente utilizza l’API per un processo che Workfront ritiene ragionevolmente oneroso per il software on-demand (ovvero, il processo causa un effetto sostanzialmente negativo sulle prestazioni del software per altri clienti), Workfront si riserva il diritto di richiedere che il cliente interrompa tale processo. Se il cliente non si conforma e il problema persiste, Workfront si riserva il diritto di terminare il processo.

URL API WORKFRONT

Per informazioni sull'URL che verrà utilizzato per chiamare l'API Workfront, vedere Formato dominio per le chiamate API Adobe Workfront.

Nozioni di base su REST

Questa sezione fornisce un’introduzione di alto livello su come interagire con l’API REST di Workfront per i seguenti principi REST:

URI oggetto

A ogni oggetto nel sistema viene assegnato un URI univoco costituito dal tipo di oggetto e dall'ID. Gli esempi seguenti mostrano gli URI che descrivono tre oggetti univoci:

/attask/api/v15.0/project/4c78821c0000d6fa8d5e52f07a1d54d0
/attask/api/v15.0/task/4c78821c0000d6fa8d5e52f07a1d54d1
/attask/api/v15.0/issue/4c78821c0000d6fa8d5e52f07a1d54d2

Il tipo di oggetto non distingue tra maiuscole e minuscole e può essere l'abbreviazione ObjCode (ad esempio proj) o il nome dell'oggetto alternativo (project).

Per un elenco di oggetti, ObjCodes validi e campi oggetto, vedi  API Explorer.

NOTA
Nel contesto dell'API di Workfront, un modulo personalizzato è un oggetto Category e un campo personalizzato è un oggetto Parameter.

Operazioni

Gli oggetti vengono manipolati inviando una richiesta HTTP al relativo URI univoco. L'operazione da eseguire è specificata dal metodo HTTP.

I metodi HTTP standard corrispondono alle operazioni seguenti:

  • GET - Recupera un oggetto in base all'ID, cerca tutti gli oggetti in base a una query, esegue report o esegue query denominate
  • POST - Inserisce un nuovo oggetto
  • PUT - Modifica un oggetto esistente
  • DELETE - Elimina un oggetto

Per ovviare alle carenze dei client o ai limiti di lunghezza del protocollo, il parametro di metodo può essere utilizzato per ignorare il comportamento HTTP. Ad esempio, un’operazione di GET può essere implementata inserendo il seguente URI:

GET/attask/api/v15.0/project?id=4c78...54d0&method=get
GET/attask/api/v15.0/project/4c78...54d0?method=get