Werken met de API voor uitsnijden work

Met de API voor uitsnijden kunt u uw configuraties voor uitlijnen maken, configureren en controleren.

Deze sectie bevat algemene informatie over het werken met de API. Een gedetailleerde API beschrijving is beschikbaar in documentatie van Adobe Journey Optimizer APIs.

API-beschrijving van uitlijnen en Postman-verzameling description

In de onderstaande tabel staan de beschikbare opdrachten voor de API voor aftiteling. De gedetailleerde informatie met inbegrip van verzoeksteekproeven, parameters, en antwoordformaten is beschikbaar in de documentatie van Adobe Journey Optimizer APIs.

Methode
Pad
Beschrijving
POST
list/endConfigs
Krijg een lijst van de eindpunt die configuraties begrenzen
POST
/endConfigs
Creeer een eindpunt het bedekken configuratie
POST
/endConfigs/{uid}/opstellen
Implementeer een configuratie voor het afdekken van eindpunten
POST
/endConfigs/{uid}/undeploy
Maak een eindpunt onbruikbaar dat configuratie begrenst
POST
/endConfigs/{uid}/canDeploy
Controle als een eindpunt het begrenzen configuratie kan worden opgesteld of niet
PUT
/endConfigs/{uid}
Een configuratie voor het afdekken van eindpunten bijwerken
GET
/endConfigs/{uid}
Retrireer een eindpunt dat configuratie begrenst
DELETE
/endConfigs/{uid}
Een configuratie voor een uitlijningselement verwijderen

Wanneer een configuratie wordt gecreeerd of bijgewerkt, automatisch wordt een controle uitgevoerd om de syntaxis en de integriteit van de lading te waarborgen.
Als sommige problemen voorkomen, keert de verrichting waarschuwing of fouten terug om u te helpen de configuratie verbeteren.

Bovendien is een inzameling van Postman beschikbaar hierom u in uw het testen configuratie te helpen.

Deze inzameling is opstelling geweest om de Variabele die inzameling van Postman te delen via de Integraties van de Console van Adobe I/O wordt geproduceerd> probeert het uit > Download voor Postman, die een dossier van het Milieu van Postman met de geselecteerde integratiewaarden produceert.

Eenmaal gedownload en geüpload naar Postman moet u drie variabelen toevoegen: {JO_HOST},{BASE_PATH} en {SANDBOX_NAME}.

  • {JO_HOST} : Journey Optimizer URL van gateway.
  • {BASE_PATH} : ingangspunt voor de API.
  • {SANDBOX_NAME}: de header x-sandbox-name (bijvoorbeeld 'prod') die overeenkomt met de sandboxnaam waar de API-operaties zullen plaatsvinden. Zie het sandboxoverzicht voor meer informatie.

Eindpuntconfiguratie

Hier is de basisstructuur van een eindpuntconfiguratie:

{
    "url": "<endpoint URL>",  //wildcards are allowed in the endpoint URL
    "methods": [ "<HTTP method such as GET, POST, >, ...],
    "services": {
        "<service name>": { . //must be "action" or "dataSource"
            "maxHttpConnections": <max connections count to the endpoint (optional)>
            "rating": {
                "maxCallsCount": <max calls to be performed in the period defined by period/timeUnit>,
                "periodInMs": <integer value greater than 0>
            }
        },
        ...
    }
}
IMPORTANT
De maxHttpConnections parameter is facultatief. Zo kunt u het aantal verbindingen beperken dat Journey Optimizer opent voor het externe systeem.
De maximale waarde die kan worden ingesteld, is 400. Als niets wordt gespecificeerd, dan kan het systeem tot veelvoudige duizenden verbindingen afhankelijk van het dynamische schrapen van het systeem openen.
Wanneer de het plafonneren configuratie wordt opgesteld, als geen "maxHttpConnection"waarde is verstrekt, wordt het gebrek "maxHttpConnection = -1"toegevoegd in de opgestelde configuratie, betekenend dat Journey Optimizer de standaardwaarde van het systeem zal gebruiken.

Voorbeeld:

`{
  "url": "https://api.example.org/data/2.5/*",
  "methods": [
    "GET"
  ],
  "services": {
    "dataSource": {
      "rating": {
        "maxCallsCount": 500,
        "periodInMs": 1000
      }
    }
  }
}
IMPORTANT
De configuratie zal slechts actief na het roepen van ​eindpunt opstellen.

Waarschuwing en fouten

Wanneer a canDeploy methode wordt geroepen, bevestigt het proces de configuratie en keert de bevestigingsstatus terug die door zijn Unieke identiteitskaart wordt geïdentificeerd, of:

"ok" or "error"

De mogelijke fouten zijn:

  • ERR_ENDPOINTCONFIG_100: het in kaart brengen van config: ontbrekende of ongeldige URL
  • ERR_ENDPOINTCONFIG_101: het in kaart brengen van config: misvormde url
  • ERR_ENDPOINTCONFIG_102: het in kaart brengen config: misvormde url: vervangingsklank in url niet toegestaan in gastheer:haven
  • ERR_ENDPOINTCONFIG_103: het in kaart brengen van config: ontbrekende methodes van HTTP
  • ERR_ENDPOINTCONFIG_104: het in kaart brengen van config: geen bepaalde vraagclassificatie
  • ERR_ENDPOINTCONFIG_107: het in kaart brengen van config: ongeldige maximum vraagtelling (maxCallsCount)
  • ERR_ENDPOINTCONFIG_108: het maximum config: ongeldige maximum vraagtelling (periodInMS)
  • ERR_ENDPOINTCONFIG_111: het in kaart brengen van config: kan geen eindpunt config tot stand brengen: ongeldige lading
  • ERR_ENDPOINTCONFIG_112: het begrenzen config: kan geen eindpunt config tot stand brengen: het verwachten van een nuttige lading JSON
  • ERR_AUTHORING_ENDPOINTCONFIG_1: ongeldige de dienstnaam <!--<given value>-->: moet "dataSource"of "actie"zijn

De mogelijke waarschuwing is:

ERR_ENDPOINTCONFIG_106: het in kaart brengen van config: maximum de verbindingen van HTTP niet bepaald: geen beperking door gebrek

Gebruiksscenario’s

Deze sectie bevat een overzicht van de belangrijkste gebruiksgevallen voor het beheer van configuraties met begrenzingen in Journey Optimizer en de bijbehorende API-opdrachten die nodig zijn om het gebruiksscenario te implementeren.

De details op elk API bevel zijn beschikbaar in de API beschrijving & inzameling van Postman.

Maak en implementeer een nieuwe configuratie voor het toewijzen van een bijschrift

API-aanroepen voor gebruik:

  1. list - Hiermee worden bestaande configuraties opgehaald.
  2. create - Maakt een nieuwe configuratie.
  3. candeploy - Controleert of de configuratie kan worden opgesteld.
  4. deploy - Implementeert de configuratie.
Werk en stel een het maximum configuratie (nog niet opgesteld) op

API-aanroepen voor gebruik:

  1. list - Hiermee worden bestaande configuraties opgehaald.
  2. get - Hiermee worden details van een specifieke configuratie opgehaald.
  3. update - Hiermee wijzigt u de configuratie.
  4. candeploy - Controleert de geschiktheid voor implementatie.
  5. deploy - Implementeert de configuratie.
Verwijder implementaties en verwijder een geïmplementeerde uitlijningsconfiguratie

API-aanroepen voor gebruik:

  1. list - Hiermee worden bestaande configuraties opgehaald.
  2. undeploy - implementeert de configuratie ongedaan.
  3. delete - Verwijdert de configuratie.
verwijder een geïmplementeerde uitlijningsconfiguratie in één stap

In slechts één API-aanroep kunt u de configuratie met behulp van de parameter forceDelete verwijderen en de implementatie ervan ongedaan maken.

API-aanroepen voor gebruik:

  1. list - Hiermee worden bestaande configuraties opgehaald.
  2. delete(met forceDelete parameter) - Dwingt schrapping van een opgestelde configuratie in één enkele stap.
Werk een reeds opgezette het maximum configuratie bij
note note
NOTE
Een herplaatsing wordt vereist na het bijwerken van een reeds opgestelde configuratie.

API-aanroepen voor gebruik:

  1. list - Hiermee worden bestaande configuraties opgehaald.
  2. get - Hiermee worden details van een specifieke configuratie opgehaald.
  3. update - Hiermee wijzigt u de configuratie.
  4. undeploy - Hiermee verwijdert u de configuratie voordat u wijzigingen aanbrengt.
  5. candeploy - Controleert de geschiktheid voor implementatie.
  6. deploy - Implementeert de bijgewerkte configuratie.
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76