개념: Adaptive Planning REST API
기본 REST API 접근 방식
Adaptive Planning API에는 3가지 일반 영역이 있습니다.
- 메타데이터 검색 및 조작
- 데이터 검색
- 데이터 생성 및 업데이트
클라이언트가 기본 Adaptive Planning 웹서비스 엔드포인트에 HTTP POST 요청을 전송하여 API 호출을 호출합니다. 엔드포인트에는 사용 중인 API 버전을 나타내는 버전 번호가 포함됩니다. Adaptive Planning API의 현재 버전은 v40입니다. 인스턴스에서 미국 이외의 지역 인증을 사용하는 경우 권한 부여 URL 및 API 엔드포인트는 지역에 따라 다릅니다. 참조 참조: 지역 인증 URL.
https://api.adaptiveplanning.com/api/v40
API 버전은 일반적으로 새로운 Adaptive Planning 제품 릴리스로 업데이트되지만, 모든 제품 릴리스에서 새 API 버전이 생성되는 것은 아닙니다. Workday는 후속 API 버전 릴리스 후 최소 1년 동안 현재 버전을 지원합니다.
API 변경 이력은 다음을 참조하십시오. 릴리스별 API 변경사항.
HTTP POST 요청에 XML 문서의 게시 데이터가 포함되어 있습니다. 이 XML 문서에는 모든 API 메서드 호출에 포함된 표준 섹션과 각 API 메서드 호출과 관련된 섹션이 포함되어 있습니다. Adaptive Planning 서버는 API 메서드 호출을 처리하고 결과를 다른 XML 문서로 반환합니다. 요청과 마찬가지로 응답 XML 문서에는 각 API 방법에 대해 동일한 섹션과 각 API 방법에 고유한 섹션이 포함됩니다.
모든 데이터 검색에서는 검색을 사용합니다. 호출자는 여러 요소와 매칭되는 조건을 지정하고, 서버는 조건과 일치하는 메타데이터 엔티티 또는 데이터의 목록으로 응답합니다. 데이터 생성 및 업데이트는 POST 지시문을 통해 제출된 데이터의 일괄 업로드를 사용합니다.
보안
사용자는 각 개별 호출에서 인증되어야 하며, 이렇게 하면 침입자가 웹서비스 세션을 도용할 가능성이 없습니다.
모든 API 요청은 HTTPS 웹 프로토콜을 사용해야 하므로 암호화됩니다. 사용자의 인증 자격증명이 웹서비스 요청 본문의 일부로 Adaptive Planning에 전송됩니다. 즉, 사용자가 컴퓨터에서 웹서비스 요청을 생성하기 전에 웹 계층에서 사용자의 로그인 ID와 비밀번호를 암호화하고 타겟 서버에서 이를 수신할 때만 암호를 해독합니다.
API 요청에서 사용자를 인증해도 해당 사용자에 대한 영구 세션은 생성되지 않습니다. 각각의 개별 웹서비스 호출은 해당 사용자를 별도로 인증해야 합니다.
권한 및 데이터 액세스 제어
사용자가 웹서비스에 액세스하는 데 특별한 권한은 필요하지 않습니다. 그러나 웹서비스를 요청하는 사용자는 요청된 액션을 수행하는 데 필요한 권한이 있어야 합니다. 예: importStandardData 웹서비스 메서드를 호출하려면 사용자에게가져오기 기능
권한이 있어야 합니다.
또한 웹서비스 메서드는 각 호출의 출력을 요청하는 사용자에게 표시되는 데이터세트로 제한합니다. 예: exportData 웹서비스 메서드는 반환되는 데이터를 호출하는 사용자가 소유한 레벨에 있는 데이터로 제한합니다.