OData API 및 API 센터 이해

API는 어플리케이션 프로그래밍 인터페이스(Application Programming Interface)를 의미합니다. API는 다양한 소프트웨어 컴포넌트 간의 통신을 위해 명확하게 정의된 메소드 세트입니다. 이 통신은 SAP SuccessFactors와 다른 서드 파티 시스템 간에 정보를 전달하는 데 유용합니다.

API는 보다 직접적인 REST(Representational State Transfer) 스타일 웹 리소스를 지향하는 추세입니다. REST(Representational State Transfer) 또는 RESTful 웹 서비스는 인터넷에서 컴퓨터 시스템 간의 상호 운용성을 제공하는 방법입니다. REST 호환 웹 서비스를 사용하면 사전 정의된 통일된 상태 비저장 작업 세트를 사용하여 시스템에서 웹 리소스의 텍스트 표현 액세스 및 조작을 요청할 수 있습니다.

다음 토픽에서는 OData를 통한 REST API와 해당 통신에 초점을 맞춥니다.

OData(개방형 데이터 프로토콜)는 RESTful API를 빌드하고 사용하는 Best Practice를 정의하는 OASIS 표준입니다. OData를 사용하면 요청 및 응답 헤더, 상태 코드, URL 규칙, 미디어 유형, 페이로드 형식, 쿼리 옵션 등을 정의하는 방법을 걱정할 필요 없이 RESTful API를 빌드하는 동안 비즈니스 로직에 집중할 수 있습니다. OData는 변경 내용 추적, 재사용 가능 프로시저의 함수 및 액션 정의, 비동기 배치 요청 전송 등에 대해서도 안내합니다.

OData는 데이터를 표현하는 방법에 대한 표준과 API에서 사용 가능한 작업과 데이터의 구조를 설명하는 메타데이터 방법을 모두 제공합니다.

표준 기반 프로토콜은 API 지원을 간소화하고 다음 고려사항만큼 채택을 늘립니다.

• OData는 SAP 표준입니다.

• 강력한 쿼리 기능은 여러 엔티티에서 데이터를 가져옵니다(SQL JOINS 생각).

• XML 또는 JSON 형식을 선택하여 중첩 데이터 구조로 데이터를 반환할 수 있습니다.

• 이 표준은 HANA Cloud 확장성에 매우 중요합니다.

• OData는 업계 표준으로 간주되므로 고객은 SFQL과 같은 SFAPI의 독점 기능과 사용자 정의 메타데이터를 학습할 필요가 없습니다.

OData API를 사용하여 다음을 수행할 수 있습니다.

1. 시스템에서 데이터를 추출하는 쿼리입니다.
2. 시스템에서 신규 데이터를 생성(삽입)합니다.
3. 시스템의 기존 데이터를 업데이트합니다.
4. 시스템에서 데이터를 삭제합니다.
5. 하나의 작업으로 여러 관련 엔티티에서 작업합니다.

메타데이터 작업을 통해 데이터 스키마를 볼 수 있다는 점에 유의해야 합니다.

• 고객 구성의 엔티티는 무엇입니까?

• 이러한 엔티티 간의 관계는 무엇입니까?

• 이러한 엔티티의 필드 및 데이터 유형은 무엇입니까?

• 필드 레이블, 필드 동작 등과 같은 다른 메타데이터 기능은 무엇입니까?

모든 MDF 엔티티는 OData API를 통해 자동으로 표시됩니다. MDF OData API를 사용하여 사용자는 MDF 엔티티에 액세스하고, MDF 엔티티를 생성, 삽입/업데이트 및 삭제할 수 있습니다. 운영자는 MDF OData API를 통해 MDF 오브젝트 정의 및 선택 목록을 생성하고 관리할 수도 있습니다. 또한 MDF OData API를 사용하여 서드 파티 시스템과 통합할 수 있습니다.

표준 OData 메타데이터의 내용 외에 언어 레이블, 선택 목록 등의 추가 정보를 가져오기 위해 SAP SuccessFactors OData는 메타데이터를 엔티티로 표시합니다.

SAP SuccessFactors OData API에는 Entity 라는 엔티티가 표시됩니다. 해당 속성은 엔티티 의 응답 본문에 임베드된 복합 유형 값으로 표시됩니다. 표준 OData 메타데이터 형식을 변경하지 않고도 다양한 형태의 메타데이터를 표시할 수 있습니다.

일반 엔티티에 액세스하는 것처럼 새로운 메타데이터에 액세스할 수 있습니다. 또한 단순 필터를 사용하여 특정 엔티티 또는 엔티티 그룹의 메타데이터를 출력할 수 있습니다.

엔티티에 대한 OData API 딕셔너리에서 가져올 수 있는 정보 외에도 메타데이터는 엔티티와 연관된 엔티티에 대한 정보, 선택 리스트, 엔티티와 다른 엔티티 간의 관계 등을 제공합니다.

API 센터는 OData API 감사 로그와 OData API 딕셔너리에 액세스할 수 있는 원스톱 매장입니다.

작업 검색에서 API 센터를 찾습니다. 해당 위치에서 볼 수 없는 경우 API 센터 액세스 권한(RBP의 통합 도구 관리 범주에서 사용 가능)이 있는지 확인하십시오.

API 센터에서 다음 액션에 액세스할 수 있습니다.

• OData API 허용 목록 작성: 기본 인증을 사용할 때 IP 허용 목록을 구성합니다. IPv4 및 IPv6 모두 지원됩니다.
• 사용자 API 옵션 관리: 직원 가져오기 옵션과 마찬가지로 사용자 쓰기 작업이 수행될 때 발생하는 선택적 작업을 설정할 수 있습니다.
  • 신규 사용자 기본 비밀번호 형식을 선택합니다.
  • 신규 사용자에게 환영 이메일을 보냅니다.
  • 관리자 및 HR 필드의 유효성을 확인합니다.
  • 비활성 직원을 처리합니다.
  • 자동 관리자 전송 또는 자동 문서 제거 와 같은 양식 회람 옵션을 지정합니다.
  .
• OData API 메타데이터 관리: OData API 메타데이터 새로 고침 및 내보내기 도구로 이동하여 캐시를 새로 고치거나 메타데이터를 XML 파일로 내보냅니다.
• 감사 로그 설정: OData API 및 SFAPI 감사 로그 설정을 구성합니다. API 감사 로그에는 API 요청 및 응답 정보(페이로드 포함)가 포함됩니다. 이 정보는 개발자가 API 호출 중에 발생한 이슈를 진단하고 API 이슈 해결을 위한 API 트랜잭션 이력을 보고 다운로드하는 데 도움이 됩니다.
• OData API 감사 로그. 상태, 엔티티 또는 OData API 호출을 포함하여 API 트랜잭션에 대한 감사 로그를 볼 수 있습니다.
• OData API 데이터 사전. 인스턴스에서 사용 가능한 모든 엔티티가 여기에 포함됩니다. 여기에는 허용되는 작업, 필드(속성 이름), 레이블, 필수 필드 또는 없는 필드가 나열됩니다.
• OData에 대한 OAuth 구성: OAuth2를 사용하여 API 사용자를 인증할 수 있도록 OAuth2 클라이언트 어플리케이션을 관리하고 등록합니다. 어플리케이션을 등록하면 어플리케이션에서 SAP SuccessFactors OData API에 액세스할 수 있는 전용 API 키가 제공됩니다.

OData 감사 로그는 OData 사용과 관련된 이슈를 지원하고 디버깅하는 데 도움이 될 수 있습니다. 감사 로그 통합 툴은 트래픽을 모니터링하고 시스템에 대한 API 요청에 대한 자세한 페이로드 정보를 가져옵니다.

그 밖의 고려사항은 다음과 같습니다.

• OData 감사 로그는 최근 10,000개의 OData 호출에 대한 페이로드 세부사항을 캡처합니다. 이 로그를 통해 시스템에 수행된 정확한 OData 페이로드 요청과 시스템에서 보낸 해당 OData 응답을 검사할 수 있습니다.

• 이 도구는 구현 중에 OData를 사용하는 개발자 또는 OData 관련 문제를 해결하는 데 도움이 되도록 이 로그의 정보를 SAP SuccessFactors HCM 솔루션 지원과 공유하려는 관리자를 위한 것입니다.

• 개별 통화의 데이터를 다운로드하여 분석을 위해 지원 담당자에게 보낼 수 있습니다.

• OData API 메타데이터 새로 고침 및 내보내기 도구

OData API 메타데이터 새로 고침 및 내보내기 도구에서 다음 버튼을 볼 수 있습니다.

• 새로 고침: 메타데이터 캐시를 새로 고칩니다. 업데이트된 메타데이터는 재생성되고 캐시에 저장되며 엑스포트와 같은 향후 작업에 사용할 수 있습니다.

• 내보내기: 메타데이터를 내보내고 다운로드합니다. 기본 내보내기 파일 이름은 CompanyName-Metadata.xml 입니다.

이 소단원의 주요 요점은 다음과 같습니다.

• API 또는 어플리케이션 프로그래밍 인터페이스(API, Application Programming Interface)는 SAP SuccessFactors와 다른 시스템 간에 정보를 주고받기 위해 소프트웨어 컴포넌트 간에 이루어지는 일련의 통신 방법입니다.

• OData 또는 개방형 데이터 프로토콜을 사용하면 REST API(Representational State Transfer)를 작성할 때 비즈니스 로직에 집중할 수 있습니다.

• OData API는 을(를) 사용하여 시스템에서 데이터를 추출하고, 신규 데이터를 생성 및 업데이트하거나, 데이터를 삭제하고, 단일 작업에서 여러 관련 엔티티에서 작업하기 위해 을(를) 사용합니다.

• API 센터 툴을 사용하여 관리자는 인스턴스에서 사용할 수 있는 모든 엔티티와 감사 로그 설정, 사용자 API 옵션 관리 또는 OData API 허용 리스트 작성 등의 기타 액션과 함께 OData API 딕셔너리에 액세스할 수 있습니다.