Salesforce API 활용 - 2

cherryjenny·2024년 5월 8일

Platform Developer Salesforce

Salesforce Platform Developer 2

목록 보기

3/6

Bulk API

Bulk API는 RESTful 기반으로, 많은 데이터를 한꺼번에 처리할 때 유용하다. 비동기로 처리된다는 점이 REST API 및 SOAP API와 다른 점이다.

Bulk API는 POST로 작업을 실행하고 , GET으로 data를 업로드 한 뒤, PATCH로 한번에 처리하는 형식을 띄고 있다.

POST

Bulk API는 REST 기반이므로 URI, HTTP method, Header, Body의 구성이 동일하다.

/services/data - REST API가 사용하는 동일한 엔드포인트를 사용하고 있다.

/jobs/ingest - Bulk API 작업을 생성하기 위해 리소스에 액세스하고 있음을 나타낸다.

body에는 다음과 같이 입력한다. Bulk API 작업은 CSV 파일로 작업하는 것이 가장 효율적이기 때문에, contentType은 CSV로, lineEnding의 경우 크게 Linux/Unix는 LF, Windows는 CRLF로 작성한다.

{
"operation" : "insert",
"object" : "Account",
"contentType" : "CSV",
"lineEnding" : "CRLF"
}

결과

"id" - 이 작업에 대해 반환된 작업 ID를 표시

"state" - 작업을 생성하면 즉시 Open상태로 설정된다. 데이터 수신을 시작할 준비가 되었음을 의미한다.

"contentUrl" - 작업에 대한 데이터를 로드하는데 사용되는 URL을 표시한다.

GET

Content-type 확인하고, Body에 raw 데이터로 입력한 뒤 send하면 별다른 response없이 201 상태코드만 오면 데이터 업로드 성공

PATCH

업로드를 다 했으면 상태를 변경하기 위해 PATCH API를 호출한다. 그럼 서버에 사용자가 데이터를 다 업로드 했으니, 처리 시작해라!! 라는 요청을 보내는 거고, 앞으로는 서버가 일을 잘 처리해주기를 기다리면 된다.

확인

서버가 일을 잘 처리했는지 확인하고 싶다면, Setup에 Bulk Data Load Jobs로 들어가 확인해보기! 몇개의 레코드가 들어갔는지, 작업 상태는 어떠한지까지 모두 체크가 가능하다.

Pub/Sub API

Pub/Sub API는 org와 외부 시스템간의 변경사항을 실시간 반영하기 위해 사용된다. Salesforce 플랫폼의 event stream을 구독하여 외부시스템을 실시간 이벤트와 통합할 수 있다. 활용 예시로 Apex 트리거, Process Builder 및 Flow Builder를 사용하여 이벤트를 감지할 수 있고, 제어도 할 수 있다. Pub/Sub API의 proto는 여기서 확인해보자!

특히 Salesforce 외부 시스템에 비즈니스 데이터가 저장되어 있는 경우 유용하다. 외부 시스템에 데이터 변경이 있을 때 Salesforce 데이터와 동기화 할 수 있을 뿐만 아니라 변경에 대응한 비즈니스 로직도 처리할 수 있기 때문! 예를 들어 외부 주문시스템의 주문을 감지하고 플랫폼 이벤트를 자동으로 알려줄 수 있다.

publish하거나 Subscribe 할 수 있는 이벤트들은 다음과 같으며, 모든 이벤트들은 event bus에 게시된다.