Salesforce Platform API의 종류

 

1. 대표 API

 

API 이름	설명	데이터 형식	동기/비동기
REST API	- RESTful 원칙에 기반한 간단하고 강력한 웹 서비스 - REST Resource 및 HTTP 메서드를 통해 모든 종류의 Salesforce 기능 노출 - EX. CRUD (만들기, 읽기, 업데이트, 삭제) - REST API는 가벼운 요청 및 응답 프레임워크가 있고, 사용하기 쉽기에 모바일 및 Web App에 적합	JSON, XML	동기식
SOAP API	- WSDL 파일을 사용하여 API를 통해 데이터에 액세스하기 위한 매개변수를 엄격하게 정의 - 대부분의 SOAP API 기능은 REST API에서도 사용이 가능 - SOAP API는 WSDL 파일을 API와 User간의 공식적인 계약으로 사용하기에, 서버 간 통합을 하는데 적합	XML	동기식
BULK API	- 대량의 데이터를 한번에 로드하고 쿼리하기 위한 특수 RESTful API - BULK란 50000개 이상의 레코드를 의미 - BULK API는 비동기식으로 이루어지기에, 요청을 하고 나중에 결과를 위해 되돌아오는 것이 가능 - 많은 양의 데이터를 처리할 때 선호 - BULK API는 1.0과 2.0버전이 존재 - 2개의 버전 모두 많은 양의 데이터를 처리한다. - BULK API는 주로 처음 데이터를 Org에 로드할 때와 같이 많은 레코드가 관련된 작업에 적합	CSV, JSON, XML	비동기식
Pub/Sub API	- Pub/Sub API를 통해 외부 시스템을 실시간 이벤트와 통합이 가능 - 데이터가 변경될 때 트리거되는 실시간 이벤트를 구독하거나 사용자 지정 이벤트를 구독 가능 - Pub/Sub 모델은 API 요청을 할 필요가 없기에 API 요청 수를 줄이는게 가능 - 즉, 변경사항을 자주 폴링해야하는 App에서 사용하는데 적합	Binary	비동기식
Connect REST API	- B2B Commerce, CMS 관리 콘텐츠, Experience Cloud 사이트, 파일, 알림, 주제 등에 대한 프로그래밍 방식 액세스를 제공 - 주로 모바일 애플리케이션에서 Connect REST API를 사용하여 피드, 사용자 및 그룹과 같은 Chatter용 UI를 구축 - 동기식으로 처리되지만, 사진은 비동기식으로 처리	JSON, XML	동기식
User Interface API	- 웹용 Salesforce와 Android, iOS 및 모바일 웹용 Salesforce를 구축하는 데 사용하는 것과 동일한 API를 사용하여 기본 모바일 앱 및 사용자 정의 웹 앱용 Salesforce UI를 구축하는게 가능  - User가 레코드, 목록 보기, 작업, 즐겨찾기 등으로 작업할 수 있는 사용자 인터페이스를 구축  - 단일 응답으로 데이터 및 메타데이터를 가져올 뿐만 아니라 응답이 Salesforce 관리자가 조직에 수행한 메타데이터 변경 사항과 일치	JSON	동기식
Analytics REST API	- Analytics REST API를 통해 프로그래밍 방식으로 데이터 세트, 렌즈 및 대시보드와 같은 Analytics Asset에 액세스가 가능  - Analytics Platform에 직접 쿼리를 전송 - Analytics Platform으로 가져온 데이터 세트에 액세스	JSON, XML	동기식
Metadata API	- Metadata API를 통해 조직에 대한 사용자 지정을 검색, 배포, 생성, 업데이트 또는 삭제  - 주로 Sandbox 또는 테스트 Org에서 프로덕션 환경으로 변경 사항을 마이그레이션하는데 사용  - 사용자 정의를 관리하고 데이터 자체가 아닌 메타데이터 모델을 관리할 수 있는 도구를 구축하기 위해 사용 - Metadata API의 기능에 액세스하는 가장 쉬운 방법은 Visual Studio Code용 Salesforce Extensions 또는 Ant 마이그레이션 도구를 사용하는 것 - 두 도구 모두 Metadata API를 기반으로 구축되었으며, 표준 도구를 사용하여 Metadata API 작업 단순화가 가능 Visual Studio Code용 Salesforce Extensions에서는 가볍고 확장 가능한 VS Code 편집기의 Salesforce 플랫폼에서 개발하기 위한 도구가 포함되어 있다. 이러한 도구는 개발 조직(스크래치 조직, 샌드박스 및 DE 조직), Apex, Aura 구성 요소 및 Visualforce 작업을 위한 기능을 제공한다. Ant 마이그레이션 도구는 로컬 디렉토리와 Salesforce 조직 간에 메타데이터를 이동하기 위해 스크립트 또는 명령줄을 사용하는 경우 이상적이다.	XML	비동기식
Tooling API	- Tooling API를 사용하여 플랫폼 애플리케이션을 위한 맞춤형 개발 도구 또는 앱을 구축 - Tooling API를 통해 기존 플랫폼 도구에 기능을 추가하고 엔터프라이즈 통합 도구에 동적 모듈을 구축이 가능  - 특정 애플리케이션이나 서비스를 위한 특수 개발 도구를 빌드도 가능 - 여러 메타데이터 유형에 대한 Tooling API의 SOQL 기능을 사용하면 더 작은 메타데이터 조각을 검색하는게 가능 - 검색이 작을수록 성능이 향상되므로 Tooling API는 대화식 애플리케이션 개발에 적합 - Tooling API는 SOAP 및 REST 인터페이스를 제공	JSON, XML, Custom	동기식