Een referentieconfiguratie maken
Last update: Tue Oct 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
API-eindpunt: platform.adobe.io/data/core/activation/authoring/credentials
Deze pagina illustreert de API aanvraag en lading die u kunt gebruiken om een credentiële configuratie tot stand te brengen gebruikend /authoring/credentials
API-eindpunt.
Wanneer gebruikt u de /credentials
API-eindpunt when-to-use
In de meeste gevallen niet de noodzaak /credentials
API-eindpunt. In plaats daarvan, kunt u de authentificatieinformatie voor uw bestemming via vormen customerAuthenticationConfigurations
parameters van de /destinations
eindpunt.
Gebruik dit API eindpunt om een credentiële configuratie tot stand te brengen slechts als er een globaal authentificatiesysteem tussen Adobe en uw bestemmingsplatform is, en Platform de klant te hoeven om geen authentificatiegeloofsbrieven te verstrekken om met uw bestemming te verbinden. In dit geval moet u een referentieconfiguratie maken met de /credentials
API-eindpunt.
Wanneer het gebruiken van een globaal authentificatiesysteem, moet u plaatsen "authenticationRule":"PLATFORM_AUTHENTICATION"
in de bestemmingslevering configuratie, wanneer het creëren van een nieuwe bestemmingsconfiguratie.
Alle parameternamen en -waarden die door Destination SDK worden ondersteund, zijn hoofdlettergevoelig. Om fouten in hoofdlettergevoeligheid te voorkomen, gebruikt u de namen en waarden van parameters exact zoals in de documentatie wordt getoond.
Aan de slag met API-bewerkingen voor gebruikersgegevens get-started
Controleer voordat je doorgaat de gids Aan de slag voor belangrijke informatie die u moet weten om met succes vraag aan API te maken, met inbegrip van hoe te om de vereiste toestemming van de bestemmings creatie en vereiste kopballen te verkrijgen.
Een verificatieconfiguratie maken create
U kunt een nieuwe geloofsgeloofsconfiguratie tot stand brengen door te maken POST
verzoek aan de /authoring/credentials
eindpunt.
API-indeling
POST /authoring/credentials
De volgende verzoeken leiden tot nieuwe geloofsconfiguraties, die door de parameters worden bepaald die in de lading worden verstrekt.
Selecteer hieronder elk tabblad om de bijbehorende lading weer te geven.
Basis
Een basisconfiguratie voor referentie maken
accordion |
verzoek |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"basicAuthentication":{
"url":"string",
"username":"string",
"password":"string"
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 layout-auto |
|
|
Parameter |
Type |
Beschrijving |
url |
Tekenreeks |
URL van leverancier van machtigingen |
username |
Tekenreeks |
Gebruikersnaam aanmeldnaam voor configuratie van aanmeldingsgegevens |
password |
Tekenreeks |
Aanmeldingswachtwoord voor configuratie van referenties |
|
accordion |
Response |
Een succesvolle reactie keert status 200 van HTTP met details van uw pas gecreëerde geloofsgeloofsconfiguratie terug. |
Amazon S3
Een Amazon S3 crediteurenconfiguratie
accordion |
Verzoek |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"s3Authentication":{
"accessId":"string",
"secretKey":"string"
}
}
|
table 0-row-3 1-row-3 2-row-3 layout-auto |
|
|
Parameter |
Type |
Beschrijving |
accessId |
Tekenreeks |
Amazon S3 toegangs-id |
secretKey |
Tekenreeks |
Amazon S3 geheime sleutel |
|
accordion |
Response |
Een succesvolle reactie keert status 200 van HTTP met details van uw pas gecreëerde geloofsgeloofsconfiguratie terug. |
SSH
Een SSH-referentieconfiguratie maken
accordion |
verzoek |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"sshAuthentication":{
"username":"string",
"sshKey":"string"
}
}
|
table 0-row-3 1-row-3 2-row-3 layout-auto |
|
|
Parameter |
Type |
Beschrijving |
username |
Tekenreeks |
Gebruikersnaam aanmeldnaam voor configuratie van aanmeldingsgegevens |
sshKey |
Tekenreeks |
SSH-sleutel voor SFTP met SSH-verificatie |
|
accordion |
Response |
Een succesvolle reactie keert status 200 van HTTP met details van uw pas gecreëerde geloofsgeloofsconfiguratie terug. |
Azure Data Lake Storage
Een Azure Data Lake Storage crediteurenconfiguratie
accordion |
verzoek |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"azureAuthentication":{
"url":"string",
"tenant":"string",
"servicePrincipalId":"string",
"servicePrincipalKey":"string"
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 layout-auto |
|
|
Parameter |
Type |
Beschrijving |
url |
Tekenreeks |
URL van leverancier van machtigingen |
tenant |
Tekenreeks |
Azure Data Lake Storage-huurder |
servicePrincipalId |
Tekenreeks |
Azure Service Principal ID for Azure Data Lake Storage |
servicePrincipalKey |
Tekenreeks |
Azure Service Principal Key for Azure Data Lake Storage |
|
accordion |
Response |
Een succesvolle reactie keert status 200 van HTTP met details van uw pas gecreëerde geloofsgeloofsconfiguratie terug. |
Azure Blob Storage
Een Azure Blob Storage crediteurenconfiguratie
accordion |
verzoek |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/credentials \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"azureConnectionStringAuthentication":{
"connectionString":"string"
}
}
|
table 0-row-3 1-row-3 layout-auto |
|
|
Parameter |
Type |
Beschrijving |
connectionString |
Tekenreeks |
Azure Blob Storage verbindingstekenreeks |
|
accordion |
Response |
Een succesvolle reactie keert status 200 van HTTP met details van uw pas gecreëerde geloofsgeloofsconfiguratie terug. |
API-foutafhandeling error-handling
Destination SDK API-eindpunten volgen de algemene API-foutberichtbeginselen voor Experience Platforms. Zie API-statuscodes en aanvragen, koptekstfouten in de het oplossen van problemengids van het Platform.
Volgende stappen next-steps
Na het lezen van dit document weet u nu wanneer om het geloofsverbindendtepunt te gebruiken en hoe te opstelling een geloofsgeloofsconfiguratie gebruikend /authoring/credentials
API-eindpunt gelezen hoe te om Destination SDK te gebruiken om uw bestemming te vormen om te begrijpen waar deze stap in het proces past om uw bestemming te vormen.