구매 보호 API 통합

아티클
05/20/2024

이 문서에서는 Microsoft Dynamics 365 Fraud Protection에서 API(실시간 애플리케이션 프로그래밍 인터페이스)를 통합하는 방법을 설명합니다.

전체 Fraud Protection 기능을 활용하려면 트랜잭션 데이터를 실시간 Fraud Protection API로 보내야 합니다. 평가 환경에서 트랜잭션 데이터를 보내면 Fraud Protection을 사용한 결과를 분석할 수 있습니다. 보호 환경에서는 구성한 규칙에 따라 결정을 내릴 수도 있습니다.

사기 방지를 사용하는 방법에 따라 다음과 같은 다양한 구매 보호 API 집합을 사용할 수 있습니다.

구매
PurchaseStatus
BankEvent
지불 거절
환불
UpdateAccount
Label

API 통합 단계

구매 보호 API의 통합은 다음 세 단계로 이루어집니다.

사기 방지를 통해 Microsoft Entra 애플리케이션을 만듭니다.
액세스 토큰을 생성합니다.
API를 호출합니다.

Important

초기 로그인을 완료하려면 Azure 테넌트에서 전역 관리자여야 합니다.

사용하려는 각 환경에 대해 다음 포털을 방문하세요. 로그인하고 사용 약관에 동의하라는 메시지가 표시되면 동의합니다.

샌드박스 환경
프로덕션 환경 (초기 등록 중에 프로덕션에서 이 단계를 이미 완료했을 수 있습니다.)

Microsoft Entra 애플리케이션 만들기

Important

이 단계를 완료하려면 Azure 테넌트에서 애플리케이션 관리자, 클라우드 애플리케이션 관리자 또는 전역 관리자여야 합니다.

API를 호출하는 데 필요한 토큰을 가져오려면 이 섹션에 설명된 대로 Microsoft Entra 애플리케이션을 구성하고 사용해야 합니다.

Microsoft Entra 애플리케이션 구성

Microsoft Entra 애플리케이션을 구성하려면 다음 단계를 수행합니다.

Fraud Protection 포털의 왼쪽 탐색 창에서 지금 Integration Create Microsoft Entra Application > Setup을 선택합니다.>
페이지를 완료하여 앱을 만듭니다. Fraud Protection과 통합하려는 각 환경에 대해 하나의 Microsoft Entra 애플리케이션을 만드는 것이 좋습니다.
다음 필수 필드에 대한 값을 입력하거나 선택합니다.
- 애플리케이션 표시 이름 – 애플리케이션에 설명이 포함된 이름을 지정합니다. 최대 길이는 93자입니다.
- 인증 방법 – 인증서 또는 비밀(암호)을 통해 인증할지 여부를 선택합니다.
인증서 인증 방법을 선택한 경우 다음 단계를 수행합니다.
1. 공개 키를 업로드하려면 파일 선택을 선택합니다. (토큰을 획득하는 경우 일치하는 프라이빗 키가 필요합니다.)
2. 암호를 선택하여 애플리케이션을 만든 후 자동으로 암호를 생성합니다.
필수 필드 설정을 마쳤으면 애플리케이션 만들기를 선택합니다. 확인 페이지에는 선택한 인증 방법에 따라 앱의 이름, ID, 인증서 지문 또는 비밀이 요약되어 있습니다.

Important

나중에 참조할 수 있는 비밀 또는 인증서 지문 정보를 저장합니다. 비밀은 한 번만 표시됩니다.

다른 애플리케이션 만들기

다른 애플리케이션을 만들려면 다른 애플리케이션 만들기를 선택합니다. 각 환경에서 API 호출을 실행하는 데 필요한 만큼의 앱을 만들 수 있습니다.

기존 Microsoft Entra 애플리케이션 관리

Microsoft Entra 앱을 만든 후 [Azure Portal](https://portal.azure.com/#blade/Microsoft_Microsoft Entra ID_IAM/ActiveDirectoryMenuBlade/RegisteredApps)을 통해 관리할 수 있습니다. 자세한 내용은 애플리케이션이 Microsoft Entra ID에 추가되는 방법 및 이유를 참조하세요.

액세스 토큰 생성

시스템을 Fraud Protection과 안전하게 통합하려면 Microsoft Entra 토큰을 가져와서 각 API 호출의 헤더에 제공합니다.

참고 항목

액세스 토큰의 수명은 60분으로 제한됩니다. 토큰이 만료될 때까지 토큰을 캐시하고 다시 사용하는 것이 좋습니다. 그런 다음 새 액세스 토큰을 가져올 수 있습니다.

토큰을 가져오려면 다음 정보가 필요합니다.

필수 ID 및 정보

환경 URI – 샌드박스 또는 프로덕션 환경에 대한 URI가 사기 방지 포털의 API Management 페이지의 구성 탭에 표시됩니다.
디렉터리(테넌트) ID – 이 ID는 Azure에서 테넌트 수행기본 GUID(Globally Unique Identifier)입니다. Azure Portal 및 사기 방지 포털의 API Management 페이지의 구성 탭에 표시됩니다.
애플리케이션(클라이언트) ID – 이 ID는 API를 호출하기 위해 만든 Microsoft Entra 앱을 식별합니다. 실시간 API 확인 페이지에서 ID를 가져오거나 나중에 Azure Portal의 앱 등록 아래에서 찾습니다. 만든 각 앱에 대해 하나의 ID가 있습니다.
인증서 지문 또는 비밀 – 실시간 API 확인 페이지에서 지문 또는 비밀을 가져옵니다.
인스턴스 ID – 이 ID는 사기 방지 환경의 GUID입니다. 사기 방지 대시보드의 통합 타일에 표시됩니다.

예: 인증서 또는 비밀을 사용하여 토큰을 획득하는 방법을 보여 주는 코드 샘플

다음 C# 코드 샘플은 인증서 또는 비밀로 토큰을 획득하는 예제를 제공합니다. 자리 표시자를 특정 정보로 바꿉다. 두 C# 샘플 모두에 대해 Microsoft.Identity.Client NuGet 패키지를 가져와야 합니다.

다른 언어의 샘플은 다음을 참조하세요 https://aka.ms/aaddev.

앱 ID 및 프라이빗 인증서 키를 사용하여 액세스 토큰 가져오기

/// <summary>
/// Gets an access token using an app ID and private certificate key.
/// </summary>
/// <param name="tenantId">Directory (tenant) ID, in GUID format</param>
/// <param name="clientId">Application (client) ID</param>
/// <param name="certPath">File path to the certificate file (pfx) used to authenticate your application to Microsoft Entra ID</param>
/// <param name="certPassword">Password to access to the certificate file's private key</param>
public async Task<string> AcquireTokenWithCertificate(string tenantId, string clientId, string certPath, string certPassword)
{
    var certificate = new X509Certificate2(certPath, certPassword);

    var app = ConfidentialClientApplicationBuilder.Create(clientId)
            .WithAuthority(AzureCloudInstance.AzurePublic, tenantId)
            .WithCertificate(certificate)
            .Build();

    var scopes = new string[] { "<API endpoint for INT or PROD>; should be https://api.dfp.microsoft-int.com/.default or https://api.dfp.microsoft.com/.default" };

    try
    {
        var result = await app.AcquireTokenForClient(scopes).ExecuteAsync();
        return result.AccessToken;
    }
    catch (MsalServiceException ex)
    {
        //Handle authentication exceptions
        throw ex;
    }
}

앱 ID 및 비밀을 사용하여 액세스 토큰 가져오기

/// <summary>
/// Gets an access token using an app ID and secret.
/// </summary>
/// <param name="tenantId">Directory (tenant) ID, in GUID format</param>
/// <param name="clientId">Application (client) ID</param>
/// <param name="clientSecret">The secret (password) used to authenticate the client (application) ID</param>
public async Task<string> AcquireTokenWithSecret(string tenantId, string clientId, string clientSecret)

{
    var app = ConfidentialClientApplicationBuilder.Create(clientId)
            .WithAuthority(AzureCloudInstance.AzurePublic, tenantId)
            .WithClientSecret(clientSecret)
            .Build();

    var scopes = new string[] { "<API endpoint for INT or PROD>; should be https://api.dfp.microsoft-int.com/.default or https://api.dfp.microsoft.com/.default" };

    try
    {
        var result = await app.AcquireTokenForClient(scopes).ExecuteAsync();
        return result.AccessToken;
    }
    catch (MsalServiceException ex)
    {
        //Handle authentication exceptions
        throw ex;
    }
}

각 사례의 AuthenticationResult 개체에는 토큰이 유효하지 않을 때를 나타내는 AccessToken 값과 ExpiresOn 속성이 포함됩니다.

POST 요청:
- https://login.microsoftonline.com/<Microsoft Entra tenant ID>/oauth2/token
헤더:
- Content-type: application/x-www-form-urlencoded
본문(키-값):
- grant_type: client_credentials
- client_id: {이전 단계의 클라이언트 ID}
- client_secret: {이전 단계의 비밀}
- resource: https://api.dfp.microsoft.com (int, https://api.dfp.microsoft-int.com)
응답:
- 다음 단계에 대한 응답에서 access_token 값을 사용합니다.

자세한 내용은 다음 Azure 설명서를 참조하세요.

API 호출

API를 호출하려면 다음 단계를 수행합니다.

각 요청에 대해 다음과 같은 필수 HTTP 헤더를 전달합니다.

헤더 이름	헤더 값
권한 부여	이 헤더에 다음 형식을 사용합니다. (Accesstoken을 Microsoft Entra ID에서 반환하는 실제 토큰 값으로 바꿉니다.) 전달자 액세스 토큰
x-ms-correlation-id	함께 만들어진 각 API 호출 집합에 새 GUID 값을 보냅니다.
x-ms-dfpenvid	인스턴스 ID의 GUID 값을 보냅니다.

헤더 이름

헤더 값

권한 부여

이 헤더에 다음 형식을 사용합니다. (Accesstoken을 Microsoft Entra ID에서 반환하는 실제 토큰 값으로 바꿉니다.)

전달자 액세스 토큰

x-ms-correlation-id

함께 만들어진 각 API 호출 집합에 새 GUID 값을 보냅니다.

x-ms-dfpenvid

인스턴스 ID의 GUID 값을 보냅니다.

이벤트 기반 페이로드를 생성합니다. 이벤트 데이터를 시스템의 관련 정보로 채웁니다. 지원되는 모든 이벤트에 대한 설명서는 Dynamics 365 Fraud Protection API를 참조하세요.
헤더(액세스 토큰 포함)와 페이로드를 결합한 다음 Fraud Protection 엔드포인트로 보냅니다.
- POST 요청:
  - <Base URL>/v1.0/merchantservices/events/purchase
- 헤더:
  - x-ms-correlation-id: {A GUID, 요청당 고유해야 함}
  - content-type: application/json
  - 권한 부여: {이전 단계의 토큰}
  - x-ms-dfpenvid: {대상 환경의 환경 ID}
- 본문:
  - 공유 Swagger 페이지에서 샘플 계정 보호 요청 본문을 가져옵니다.

참고 항목

새 환경을 만드는 경우 트랜잭션을 올바르게 라우팅할 수 있도록 통합하는 동안 API 헤더에 환경 ID를 포함합니다.

다음 옵션은 API 호출에서 x-ms-dfpenvid에 허용되며 동작은 동일합니다.

호출하는 환경에 대한 환경 ID를 사용합니다. ID는 환경 ID 필드의 통합 페이지에 나열됩니다.
슬래시(/)를 구분선으로 사용하여 루트에서 호출하는 자식 환경까지 고객 API ID의 전체 팻을 사용합니다. 예를 들어 /primary/XYZ입니다.
슬래시(/)를 구분선으로 사용하여 루트에서 호출하는 자식 환경까지 환경 ID 또는 고객 API ID의 전체 경로를 사용합니다. 예를 들어 7b925ca8-d372-4245-bc5a-94b5fdb6c067/XYZ입니다.

환경을 만들 때 고객 API ID를 지정하려면 환경 관리 문서를 참조하세요.

모범 사례

각 Microsoft Entra 토큰은 60분 동안 유효한 기본. 더 짧은 기간 동안 캐시하고 다시 사용하는 것이 좋습니다.
HttpClient에 연결 유지가 있는지 확인합니다.
항상 x-ms-dfpenvid 헤더를 전달하고 대신 트랜잭션을 보내려는 가맹점의 환경을 가리키는지 확인합니다.
비밀 저장소에 비밀을 저장합니다.
사기 방지를 사용하여 향후 디버깅 세션을 위해 항상 x-ms-correlation-id 헤더를 전달합니다.
사기 방지로 전송되는 모든 트랜잭션에 대해 x-ms-correlation-id 헤더가 고유해야 합니다.

샘플 앱 보기

추가 참조를 위해 샘플 가맹점 앱 및 함께 제공되는 개발자 설명서를 볼 수 있습니다. 샘플 앱은 고객 계정 업데이트, 환불 및 환불을 실시간으로 보내는 API 이벤트를 포함하여 Fraud Protection API를 호출하는 방법의 예를 제공합니다. 샘플 앱에 대한 설명서는 이러한 링크가 가능할 때마다 실제 샘플 코드에 연결됩니다. 그렇지 않으면 코드 샘플이 설명서에 직접 존재합니다.

사용할 샘플 사이트를 구성하는 방법에 대한 지침은 샘플 사이트 구성을 참조하세요.

다음을 통해 공유

구매 보호 API 통합

API 통합 단계

Microsoft Entra 애플리케이션 만들기

Microsoft Entra 애플리케이션 구성

다른 애플리케이션 만들기

기존 Microsoft Entra 애플리케이션 관리

액세스 토큰 생성

필수 ID 및 정보

예: 인증서 또는 비밀을 사용하여 토큰을 획득하는 방법을 보여 주는 코드 샘플

앱 ID 및 프라이빗 인증서 키를 사용하여 액세스 토큰 가져오기

앱 ID 및 비밀을 사용하여 액세스 토큰 가져오기

API 호출

모범 사례

샘플 앱 보기

피드백

피드백

추가 리소스