API 고려 사항

API 버전 관리

참고 항목

Cloud 파트너 포털 API는 파트너 센터와 통합되었으며, 계속 파트너 센터에서 작동합니다. 전환에는 작은 변경 내용이 도입됩니다. 파트너 센터로 전환한 후에도 코드가 계속 작동하도록 Cloud 파트너 포털 API 참조에 나열된 변경 내용을 검토합니다. CPP API는 파트너 센터로 전환하기 전에 이미 통합된 기존 제품에만 사용해야 합니다. 새 제품은 파트너 센터 제출 API를 사용해야 합니다.

동시에 사용할 수 있는 여러 버전의 API가 있을 수 있습니다. 클라이언트는 쿼리 문자열의 일부로 api-version 매개 변수를 제공하여 호출하려는 버전을 나타내야 합니다.

GET https://cloudpartner.azure.com/api/offerTypes?api-version=2017-10-31

알 수 없거나 잘못된 API 버전이 있는 요청에 대한 응답은 HTTP 코드 400입니다. 이 오류는 응답 본문의 알려진 API 버전 컬렉션을 반환합니다.

    {
        "error": { 
            "code":"InvalidAPIVersion",
            "message":"Invalid api version. Allowed values are [2016-08-01-preview]"
        }
    }

Errors

API는 해당 HTTP 상태 코드와 필요에 따라 JSON으로 직렬화된 응답의 추가 정보를 사용하여 오류에 응답합니다. 오류, 특히 400클래스 오류가 발생하면 기본 원인을 수정하기 전에 요청을 다시 시도하지 마세요. 예를 들어 위의 샘플 응답에서 요청을 다시 보내기 전에 API 버전 매개 변수를 수정합니다.

권한 부여 헤더

이 참조의 모든 API에 대해 Microsoft Entra ID에서 가져온 전달자 토큰과 함께 권한 부여 헤더를 전달해야 합니다. 이 헤더는 유효한 응답을 받는 데 필요합니다. 오류가 401 Unauthorized 없으면 오류가 반환됩니다.

  GET https://cloudpartner.azure.com/api/offerTypes?api-version=2016-08-01-preview

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>