Requisiti

Conoscenza dei prerequisiti

  • Informazioni su AEM Mobile
  • Conoscenza della creazione e della pubblicazione di contenuto tramite il portale on-demand standard

Prodotti richiesti

  • AEM Mobile

Introduzione

Le On-Demand Services API di Adobe Experience Manager consentono a uno sviluppatore di terze parti di integrarsi con i servizi on-demand. Tali servizi consentono di:

  • gestire gli articoli
  • gestire le raccolte
  • gestire i prodotti
  • gestire le notifiche push

Le On-Demand Services API (precedentemente denominate “Content Producer Service APIs”) sono le stesse API utilizzate dal portale on-demand (https://aemmobile.adobe.com).

Content Producer Service API di Adobe Digital Publishing Solution

Integrazione con la creazione AEM

Potete usare AEM per produrre contenuto per le app AEM Mobile. Per ulteriori informazioni, contattate il rappresentante Adobe.

Integrazioni di terze parti

Per i seguenti sistemi di flusso di lavoro editoriali, Content Management Systems (CMS) e le soluzioni di creazione basate su Web, sono disponibili delle integrazioni (dai partner Adobe):

Sistemi CMS

Authoring basato su Web
Sistemi di flussi di lavoro

Integrazione della panoramica video

Klaasjan Tukker e Mike Yang hanno fornito questa presentazione sulle possibilità di flusso di lavoro avanzato in occasione della conferenza MAX 2015:

Possibilità flusso di lavoro avanzate con le API Adobe (in inglese) (1:25:57)

Download

Per iniziare a lavorare con On-Demand Services API, scaricate i file elencati di seguito.

Nota:

Scaricando il software riportato di seguito, l'utente dichiara di aver letto e accettato le condizioni della licenza delle API per AEM Mobile Services, le Condizioni d'uso di Adobe.com e l'Informativa sulla privacy online di Adobe.

Scarica

Questo file .zip contiene i seguenti elementi:

  • Documentazione API
  • Definizioni dello schema JSON
  • Esempi di codice
  • Esempi di scripting di InDesign
  • Modulo di richiesta di chiave API

 

Come utilizzare la documentazione API

Per visualizzare la documentazione API (creata con Swagger), decomprimete i file in una cartella sul server Web (ad esempio MAMP).

Se l'URL in hosting per la documentazione swagger è http://localhost:8888/aemmobile-swagger, potete ignorare il passaggio seguente.

Aprite il file ‘service.json’ e modificate la riga 55 per impostare basePath sull'host+percorso in cui è possibile accedere alla documentazione, ad esempio:

#53     “contact”: "wwds@adobe.com"
#54   },
#55   "basePath": "http://localhost:8888/your-custom-path"
#56 }

Aprite il browser Web e cercate il percorso in cui avete distribuito la documentazione. On-Demand Services API deve essere visibile.

 

Configurare il progetto, i ruoli e gli utenti

Configurate un progetto, create i ruoli e consentite l'accesso agli utenti. Per ulteriori informazioni, consultate i seguenti articoli della guida:

È buona norma evitare di utilizzare lo stesso Adobe ID per account cui siano stati concessi diritti di amministrazione come “Master Account” e “Full project”. Create un Adobe ID con diritti di accesso esclusivamente a operazioni che desiderate rendere realizzabili per mezzo di On-Demand Services API.

Nota:

assicuratevi di avviare un nuovo progetto per eseguire gli esempi elencati di seguito.

Chiavi API

Per accedere a On-Demand Services API e per integrare sistemi di terze parti, è necessario richiedere una chiave API.

Richiesta di una chiave API

Per accedere a On-Demand Services API, è necessario richiedere una chiave API. Per richiedere la chiave API, completate il modulo PDF. Inviate il modulo compilato all'Assistenza sviluppatori di Adobe: wwds@adobe.com

Scarica

Per ulteriori informazioni sui casi in cui è necessaria una chiave API o su quando utilizzarne una esistente, consultate Utilizzo delle chiavi API di AEM Mobile.

Generare device_id e device_token

Una volta ottenuta la chiave API, è possibile generare device_id e device_token. Accedete a https://aex.aemmobile.adobe.com ed effettuate le seguenti operazioni:

  • Fornite la chiave API
  • Accedete utilizzando l'Adobe ID che avete richiesto di inserire nella lista bianca all'interno del modulo di richiesta

Se tutte le condizioni sono soddisfatte, verranno generati i device_id e device_token.

Come utilizzare i file di esempio

Decomprimete i file di esempio e personalizzate i valori predefiniti in base alle chiavi API e al vostro account. Assicuratevi di aver creato un nuovo progetto nel portale on-demand e di aver assegnato un ruolo all'Adobe ID che verrà utilizzato per comunicare con gli esempi di API.

Modificare:

  • config/credentials.php

Modificate/aggiungete i valori per 'client_id', 'client_secret' (la vostra chiave API), 'client_secret', 'device_token', 'device_id' (dal servizio AEX).

Impostate il valore per 'client_version'. In tal modo potrete identificare il vostro sistema nelle comunicazioni con On-Demand Services API. Ad esempio, 'aemmobile-learn-api-doc-1.0'

Eseguire:

  • demo/01_get_access_token.php

Se le impostazioni sono corrette, dovreste ricevere un avviso con un 'access_token'. Utilizzate questo access_token nelle chiamate di assistenza successive.

Modificare:

  • config/credentials.php

Aggiungete il valore per 'access_token'.

Eseguire:

  • demo/02_get_user_permissions.php

Se le impostazioni sono corrette, dovreste ricevere un avviso contenente un elenco di progetti cui l'Adobe ID (per il quale è stato generato il device_id/device_token) ha accesso.

Selezionate il progetto con il quale desiderate interagire (è preferibile selezionare un progetto nuovo o creato di recente). Il codice identificativo del progetto è di tipo GUID, ad esempio '8dbeb5da-ca73-d0da-b0b0-885fb83e7ae8'.

Modificare:

  • Config/parameters.php

Aggiornate 'publication_id' con l'ID progetto ottenuto in precedenza.

Eseguire:

  • demo/03_update_home_collection.php

Se configurato correttamente, lo stato della raccolta di livello principale diventerà “Pubblicabile”: caricamento della miniatura e dell'immagine di sfondo, impostazione dell'ID prodotto e associazione del layout predefinito.

Modificare:

  • config/parameters.php

Se il progetto di destinazione è una raccolta di livello principale 2, aggiornate il valore di 'collection_home_name' da 'topLevelContent' a 'topLevelTabletContent' per i tablet (o 'topLevelPhoneContent' per i telefoni).

Siete ora nelle condizioni per eseguire gli esempi rimanenti. Al momento dell'esecuzione degli esempi, mantenete un browser con il portale on-demand aperto nella sezione “Contenuti e layout” dei vostri progetti: potete così visualizzare le modifiche in tempo reale sul browser durante l'esecuzione degli esempi.

 

Creare articoli

Il contenuto per gli articoli può essere creato in HTML o con InDesign.

Articoli HTML

Gli articoli creati in HTML possono utilizzare CSS/JS per determinare visivamente lo stile del contenuto e renderlo reattivo. Tutto il contenuto HTML deve trovarsi nella stessa cartella (sono ammesse sottocartelle). I file HTML saranno compressi in un ‘file zip’ con un file manifest.xml. Il file di manifesto specifica quali articoli fanno parte del pacchetto articoli e contiene il checksum MD5 (consultate Creare articoli HTML per AEM Mobile).

Per generare i file di articolo da una cartella, è possibile utilizzare la utility del desktop o il packager degli esempi in ‘class/manifest.php’.

Articoli InDesign

Con Adobe InDesign CS6 o versione successiva, potete creare file di articolo con layout fisso. Con il plugin di Digital Publishing, potete esportare il contenuto di InDesign in un file di articolo (consultate Creare articoli AEM Mobile in InDesign).

Per eseguire uno script sul processo di esportazione, potete utilizzare la funzione ‘exportDpsArticle’. Per i dettagli, consultate Creazione di articoli basati su InDesign tramite script.

Domande e supporto

È possibile formulare qualsiasi quesito riguardante questo articolo o l'utilizzo di On-Demand Services API nel forum sull'API e sull'integrazione. Se avete bisogno di un supporto individuale, contattate il Supporto per sviluppatori di Adobe (wwds@adobe.com).

Registro delle modifiche

20 giugno 2017

Documentazione aggiornata:

  • Corretto un errore ortografico nella descrizione.

7 febbraio 2017

Documentazione aggiornata:

  • Aggiunto il supporto per il contenuto dinamico condiviso tra i Producer Services.

Schema JSON aggiornato:

  • Aggiunto nuovo schema JSON per il contenuto dinamico condiviso.

Esempi di API:

  • Aggiunto il supporto per il contenuto dinamico condiviso.

1 novembre 2016

Documentazione aggiornata:

  • Aggiunto il ritorno in batch dello stato dell'entità.
  • Aggiunto il supporto per il banner dinamico tra Producer e Ingestion Services.
  • Aggiunto il supporto per la notifica push Android tramite l'API di servizio di notifica
  • Aggiunta la capacità di aggiornare l'elenco di elementi di contenuto della raccolta in corrispondenza di un'indice specificato.

Schema JSON aggiornato:

  • Aggiunto nuovo schema JSON per il banner dinamico

Esempi di API aggiornate:

  • Raccolta di aggiornamento:: updateContentElements() per verificare se esiste già prima di aggiungere un'entità all'elenco di elementi di contenuto della raccolta
  • Aggiunto il supporto per il banner dinamico
  • Aggiunto il banner dinamico agli script demo dimostrativi (n. 13 – 15)

12 luglio 2016

Documentazione aggiornata:

  • Prodotto aggiornato e bundle di prodotti

30 giugno 2016

Documentazione aggiornata:

  • Sono state aggiunte informazioni sul caricamento dei PDF per il servizio di inserimento

Schema JSON aggiornato: 12 luglio 2016

Documentazione aggiornata:

  • Aggiunti altri campi di metadati:
    • contentSize
    • availabilityDate (solo prodotto e bundle di prodotti)
    • availabilityDateTimezone (solo prodotto e bundle di prodotti)

Esempi di API aggiornate:

  • Demo: #05e aggiornare il file PDF per l'articolo uno
  • Demo: #05f aggiornare il file PDF per l'articolo uno e impostare lo scorrimento orizzontale
  • Demo: #05g verificare lo stato di inserimento per l'articolo uno
  • Passato all'utilizzo dell'autoloader per il caricamento delle classi necessarie per lo script PHP

10 maggio 2016

Documentazione aggiornata:

  • Il servizio di inserimento ora accetta l'intestazione: application/pdf
  • Tenete traccia dello stato di una pubblicazione/annullamento della pubblicazione noti ed eseguite la verifica preliminare dei processi
    • POST /job restituiranno l'ID del flusso di lavoro per questo processo
    • GET /status/{publicationID}/publication/00000000-0000-0000-0000-000000000000 restituiranno l'ID del flusso di lavoro corrente (se disponibile)
    • Confrontate l'ID del flusso di lavoro corrente (se disponibile) con l'ID dell'ultimo flusso di lavoro noto
      • se ID flusso di lavoro corrente === ID ultimo flusso di lavoro noto, l'ultimo processo è ancora in corso
      • se ID flusso di lavoro corrente !== ID dell'ultimo flusso di lavoro noto, l'ultimo processo è completato e ne è in corso un altro
      • se l'ID del flusso di lavoro corrente è vuoto, l'ultimo processo è completato e non vi sono altri processi in corso

Esempi di API aggiornate:

  • Demo: #05d verificare la dimensione del file di contenuti caricato corrente
  • Demo: #08c tenere traccia dell'ultimo stato del flusso di lavoro noto

Questo prodotto è concesso in licenza in base alla licenza di Attribuzione-Non commerciale-Condividi allo stesso modo 3.0 Unported di Creative Commons.  I post su Twitter™ e Facebook non sono coperti dai termini di Creative Commons.

Note legali   |   Informativa sulla privacy online