L’implementazione dell’endpoint /app_configurations
è in continua evoluzione, di pari passo con l’aggiunta, la rimozione e la rielaborazione delle varie funzioni.
Le configurazioni dell’app consentono di memorizzare le credenziali e recuperarle per un utilizzo successivo. L’endpoint /app_configurations
nell’API di Reactor consente di gestire programmaticamente le configurazioni di app all’interno dell’applicazione Experience.
L’endpoint utilizzato in questa guida fa parte dell’API di Reactor. Prima di continuare, consulta la guida introduttiva per informazioni importanti su come eseguire l’autenticazione nell’API.
Formato API
GET /companies/{COMPANY_ID}/app_configurations
Parametro | Descrizione |
---|---|
COMPANY_ID |
id dell’azienda proprietaria delle configurazioni di app. |
Utilizzando i parametri di query, le configurazioni di app elencate possono essere filtrate in base ai seguenti attributi:
app_id
created_at
key_type
messaging_service
name
platform
updated_at
Richiesta
curl -X GET \
https://reactor.adobe.io/companies/COdb0cd64ad4524440be94b8496416ec7d/app_configurations \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
Risposta
In caso di esito positivo, la risposta restituisce un elenco di configurazioni di app.
{
"data": [
{
"id": "AC40c339ab80d24c958b90d67b698602eb",
"type": "app_configurations",
"attributes": {
"created_at": "2020-12-14T17:31:10.626Z",
"updated_at": "2020-12-14T17:31:10.626Z",
"app_id": "com.adobe.test_app",
"name": "Kessel Apns App",
"platform": "mobile",
"messaging_service": "apns",
"key_type": "p8_file"
},
"relationships": {
"company": {
"links": {
"related": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb/company"
},
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
}
},
"links": {
"company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"self": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb"
}
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Per cercare una configurazione di app occorre specificare il relativo ID nel percorso di una richiesta GET.
Formato API
GET /app_configurations/{APP_CONFIGURATION_ID}
Parametro | Descrizione |
---|---|
APP_CONFIGURATION_ID |
id della configurazione di app che desideri cercare. |
Richiesta
curl -X GET \
https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
Risposta
In caso di esito positivo, la risposta restituisce i dettagli della configurazione di app.
{
"data": {
"id": "AC40c339ab80d24c958b90d67b698602eb",
"type": "app_configurations",
"attributes": {
"created_at": "2020-12-14T17:31:10.626Z",
"updated_at": "2020-12-14T17:31:10.626Z",
"app_id": "com.adobe.test_app",
"name": "Kessel Apns App",
"platform": "mobile",
"messaging_service": "apns",
"key_type": "p8_file"
},
"relationships": {
"company": {
"links": {
"related": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb/company"
},
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
}
},
"links": {
"company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"self": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb"
}
}
}
Per creare una nuova configurazione di app, devi eseguire una richiesta POST.
Formato API
POST /companies/{COMPANY_ID}/app_configurations
Parametro | Descrizione |
---|---|
COMPANY_ID |
id dell’azienda in cui stai definendo la configurazione di app. |
Richiesta
curl -X POST \
https://reactor.adobe.io/companies \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/vnd.api+json;revision=1' \
-d '{
"data": {
"attributes": {
"name": "Kessel Apns App",
"app_id": "com.adobe.test_app",
"platform": "mobile",
"messaging_service": "apns",
"key_type": "p8_file",
"push_credential": {
"bundleId": "com.adobe.test_app",
"keyId": "{KEY_ID}",
"p8": "{SECRET}",
"teamId": "{TEAM_ID}"
}
},
"type": "app_configurations"
}
}'
Proprietà | Descrizione |
---|---|
platform |
Piattaforma su cui viene eseguita l’applicazione (web o mobile). Questo determina quali servizi di messaggistica sono disponibili. |
messaging_service |
Il servizio di messaggistica associato all’app, ad esempio Apple Push Notification Service (APNs) e Firebase Cloud Messaging (FCM). Questo determina quali tipi di chiave possono essere utilizzati. |
key_type |
Rappresenta il protocollo supportato da un fornitore di servizi push e determina il formato dell’oggetto push_credential . Man mano che i protocolli si evolvono per i servizi di messaggistica, vengono creati nuovi valori key_type per supportare i protocolli aggiornati. |
push_credential |
Valore effettivo delle credenziali, che a riposo è crittografato. Questo campo non viene normalmente decrittografato né incluso nelle risposte API. Solo alcuni servizi di Adobe possono ricevere una risposta contenente credenziali push decrittografate. |
Risposta
In caso di esito positivo, la risposta restituisce i dettagli della nuova configurazione di app appena creata.
{
"data": {
"id": "AC40c339ab80d24c958b90d67b698602eb",
"type": "app_configurations",
"attributes": {
"created_at": "2020-12-14T17:31:10.626Z",
"updated_at": "2020-12-14T17:31:10.626Z",
"app_id": "com.adobe.test_app",
"name": "Kessel Apns App",
"platform": "mobile",
"messaging_service": "apns",
"key_type": "p8_file"
},
"relationships": {
"company": {
"links": {
"related": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb/company"
},
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
}
},
"links": {
"company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"self": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb"
}
}
}
Per aggiornare la configurazione di un’app, devi includere il relativo ID nel percorso di una richiesta PATCH.
Formato API
PATCH /app_configurations/{APP_CONFIGURATION_ID}
Parametro | Descrizione |
---|---|
APP_CONFIGURATION_ID |
id della configurazione di app che desideri aggiornare. |
Richiesta
La richiesta seguente aggiorna l’app_id
per la configurazione di un’app esistente.
curl -X PATCH \
https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/vnd.api+json;revision=1' \
-d '{
"data": {
"attributes": {
"app_id": "com.adobe.test_app_2"
},
"id": "AC40c339ab80d24c958b90d67b698602eb",
"type": "app_configurations"
}
}'
Proprietà | Descrizione |
---|---|
attributes |
Oggetto le cui proprietà rappresentano gli attributi da aggiornare per la configurazione di app. Ogni chiave rappresenta il particolare attributo di configurazione di app da aggiornare, insieme al valore corrispondente a cui deve essere aggiornato. I seguenti attributi possono essere aggiornati per le configurazioni di app:
|
id |
id della configurazione di app che desideri aggiornare. Deve corrispondere al valore {APP_CONFIGURATION_ID} fornito nel percorso della richiesta. |
type |
Tipo di risorsa da aggiornare. Per questo endpoint, il valore deve essere app_configurations . |
Risposta
In caso di esito positivo, la risposta restituisce i dettagli della configurazione di app aggiornata.
{
"data": {
"id": "AC40c339ab80d24c958b90d67b698602eb",
"type": "app_configurations",
"attributes": {
"created_at": "2020-12-14T17:31:10.626Z",
"updated_at": "2020-12-14T17:31:21.787Z",
"app_id": "com.adobe.test_app_2",
"name": "Kessel Apns App",
"platform": "mobile",
"messaging_service": "apns",
"key_type": "p8_file"
},
"relationships": {
"company": {
"links": {
"related": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb/company"
},
"data": {
"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
}
},
"links": {
"company": "https://reactor.adobe.io/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"self": "https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb"
}
}
}
Puoi eliminare una configurazione di app includendo il relativo ID nel percorso di una richiesta DELETE.
Formato API
DELETE /app_configurations/{APP_CONFIGURATION_ID}
Parametro | Descrizione |
---|---|
APP_CONFIGURATION_ID |
id della configurazione di app che desideri eliminare. |
Richiesta
curl -X DELETE \
https://reactor.adobe.io/app_configurations/AC40c339ab80d24c958b90d67b698602eb \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H "Content-Type: application/vnd.api+json" \
-H 'Accept: application/vnd.api+json;revision=1'
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 204 (nessun contenuto) senza corpo di risposta, a indicare che la configurazione di app è stata eliminata.