Een referentieconfiguratie maken
Last update: Tue Jul 16 2024 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 referentieconfiguratie te maken met behulp van het API-eindpunt /authoring/credentials
.
Wanneer gebruikt u het API-eindpunt /credentials
when-to-use
In de meeste gevallen, te hoeven u niet om het /credentials
API eindpunt te gebruiken. In plaats daarvan kunt u de verificatiegegevens voor uw doel configureren via de customerAuthenticationConfigurations
-parameters van het /destinations
-eindpunt.
Gebruik dit API eindpunt om een credentieconfiguratie tot stand te brengen slechts als er een globaal authentificatiesysteem tussen Adobe en uw bestemmingsplatform is, en de Platform klant te hoeven om geen authentificatiegeloofsbrieven te verstrekken om met uw bestemming te verbinden. In dit geval moet u een referentieconfiguratie maken met het API-eindpunt van /credentials
.
Wanneer het gebruiken van een globaal authentificatiesysteem, moet u "authenticationRule":"PLATFORM_AUTHENTICATION"
in de 🔗 2} configuratie van de bestemmingslevering plaatsen, wanneer creërend een nieuwe bestemmingsconfiguratie.
Alle parameternamen en waarden die door Destination SDK worden gesteund zijn gevoelig geval. 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
Alvorens verder te gaan, te herzien gelieve begonnen gidsvoor belangrijke informatie die u moet kennen om vraag aan API met succes te maken, met inbegrip van hoe te om de vereiste toestemming van de bestemmings authoring en vereiste kopballen te verkrijgen.
Een verificatieconfiguratie maken create
U kunt een nieuwe aanmeldingsconfiguratie maken door een POST
-aanvraag in te dienen bij het /authoring/credentials
-eindpunt.
API formaat
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
creeer een basiscredentiële configuratie
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 |
String |
URL van leverancier van machtigingen |
username |
String |
Gebruikersnaam aanmeldnaam voor configuratie van aanmeldingsgegevens |
password |
String |
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
creeer een Amazon S3 credentiële configuratie
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 |
String |
Amazon S3 toegangs-id |
secretKey |
String |
Amazon S3 geheime sleutel |
|
accordion |
Response |
Een succesvolle reactie keert status 200 van HTTP met details van uw pas gecreëerde geloofsgeloofsconfiguratie terug. |
SSH
creeer een SSH credentiële configuratie
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 |
String |
Gebruikersnaam aanmeldnaam voor configuratie van aanmeldingsgegevens |
sshKey |
String |
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 de Opslag van het meer van Gegevens
creeer een Azure Data Lake Storage credentiële configuratie
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 |
String |
URL van leverancier van machtigingen |
tenant |
String |
Azure Data Lake Storage-huurder |
servicePrincipalId |
String |
Azure Service Principal ID for Azure Data Lake Storage |
servicePrincipalKey |
String |
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
creeer een Azure Blob Storage credentiële configuratie
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 |
String |
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. Verwijs naar API statuscodesen de fouten van de verzoekkopbalin de het oplossen van problemengids van het Platform.
Volgende stappen next-steps
Na het lezen van dit document, weet u nu wanneer om het geloofseindeindpunt te gebruiken en hoe te opstelling een geloofsconfiguratie gebruikend het /authoring/credentials
API eindpunt Lees hoe te om Destination SDK te gebruiken om uw bestemmingte vormen om te begrijpen waar deze stap in het proces past om uw bestemming te vormen.