데이터 출처 및 API

Sendtric API를 사용하여 데이터 출처로 레코드를 전송하는 방법

마지막 업데이트

API 데이터 출처를 사용하면, 데이터가 변경될 때마다 귀사의 시스템에서 Sendtric으로 JSON 레코드를 전송합니다. Sendtric은 이를 호스팅 데이터로 저장하며, 이메일이 열릴 때마다 귀사의 이미지가 각 구독자의 레코드를 조회합니다.

이 가이드는 데이터를 전송하는 코드를 작성하는 모든 분을 위한 것입니다. Sendtric이 메일이 열릴 때마다 API에서 데이터를 가져오도록 설정하고 싶다면, 데이터 출처를 자체 API에 연결하는 방법.

데이터 소스 생성

  1. 왼쪽 사이드바에서 다음을 클릭하세요 데이터 출처를 클릭한 다음 새 데이터 출처.
  2. 아래 API에서 API를 선택한 후 '계속'을 클릭하세요.
  3. 선택 'Sendtric으로 데이터 전송'을 선택하고을 선택한 후 '계속'을 클릭하세요.
  4. 다음 내용을 기입하세요:
    • 데이터 소스 이름: 예: "로열티 회원".
    • 고유 식별자 필드: 각 레코드를 식별하는 JSON 필드로, 예를 들어 customer_id 또는 email와 같이 각 레코드를 식별하는 JSON 필드입니다. 전송하는 모든 레코드에는 이 필드가 반드시 포함되어야 합니다.
    • 설명 (선택 사항).
  5. 클릭 데이터 소스 저장를 클릭합니다. 데이터 출처가 생성되고 API 단계에 엔드포인트와 API 키가 표시됩니다.
  6. 필요한 내용을 복사한 다음, '계속'을 클릭하여 완료하십시오.
새 데이터 출처의 API 단계로, 단일 레코드 및 대량 업서트(upsert) 엔드포인트, API 키 및 요청 예시가 표시됩니다.

데이터 소스의 API 세부 정보 탭에서 다시 확인할 수 있습니다.

인증

모든 요청의 Authorization 모든 요청의 헤더에 키를 포함시켜 주십시오:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

The 데이터 출처 API 키는 데이터 출처 레코드를 전송하는 용도로만 사용되므로, 개발자나 자동화 도구에 제공해도 안전합니다. API 요금제를 이용 중이라면, 기존 API 키를 이 엔드포인트에서도 사용할 수 있습니다.

키를 프론트엔드 코드나 공개 저장소에 포함하지 마세요. 만약 키가 노출된 적이 있다면, 다음 명령어를 사용하여 키를 다시 생성하세요. 설정 → API 키 → 데이터 출처 API 키에서 키를 다시 생성한 다음, 해당 키를 사용하는 모든 항목을 업데이트하십시오.

레코드 생성 또는 업데이트

Sendtric에 표시된 엔드포인트로 단일 JSON 객체 또는 객체 배열을 POST하세요. 레코드 하나:

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "customer_id": "CUST_1001",
  "first_name": "Sarah",
  "points": 1250
}

한 번의 요청에 여러 개의 레코드 포함:

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

[
  { "customer_id": "CUST_1001", "first_name": "Sarah", "points": 1250 },
  { "customer_id": "CUST_1002", "first_name": "James", "points": 300 }
]

기록이 저장되는 방식:

  • 해당 식별자를 가진 레코드가 아직 없다면, 새로운 레코드가 생성됩니다.
  • 만약 그렇다면, 그것은 보내주신 내용으로 귀하가 보내신 내용으로 대체됩니다. 생략한 필드는 제거되므로, 항상 전체 레코드를 보내주십시오.
  • 새로 추가되거나 업데이트된 기록은 대개 1분 이내에 확인할 수 있습니다.
  • 식별자는 대소문자를 구분하지 않고 일치 여부를 확인합니다.

요청이 성공하면 200 간략한 요약과 함께 반환되며, 예를 들면 다음과 같습니다. {"status":"ok","records":2}.

레코드 내에 객체를 중첩할 수 있습니다. 예를 들어 "address": { "city": "Leeds" }, 이미지 편집기에서 중첩된 필드를 선택할 수 있습니다.

레코드 삭제

엔드포인트 끝에 해당 레코드의 식별자를 추가하여 레코드 하나를 삭제하려면:

DELETE <your data source endpoint>/cust_1001
Authorization: Bearer YOUR_API_KEY

식별자 배열을 전송하여 여러 개를 삭제합니다:

DELETE <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

["cust_1001", "cust_1002"]

한계

한도값
요청당 기록 수10,000
요청 크기10 MB
식별자 값255자
임의의 단일 텍스트 값10 KB
중첩 깊이20단계

레코드 하나당 요청을 하나씩 보내는 대신, 레코드를 일괄적으로 전송하세요. 수천 개의 레코드가 있는 경우, 데이터 출처로 대량의 데이터를 전송하는 방법을 참조하십시오.

응답 및 오류

상태그 의미는 무엇인가어떻게 해야 할까요?
200접수된 기록아무것도 없습니다. 일부 레코드가 건너뛴 경우, X-Skipped-Records 헤더에 그 개수가 표시됩니다.
400이 내용은 유효한 JSON이 아닙니다.요청 본문을 확인하세요
401API 키가 없거나 잘못되었습니다.Authorization 헤더를 확인하세요
404이 키에 대한 데이터 출처를 찾을 수 없습니다.엔드포인트를 확인하고, 해당 키가 동일한 계정에 속하는지 확인하십시오.
413레코드가 너무 많거나 크기가 너무 큼요청을 더 작은 배치로 나누세요
422기록을 저장할 수 없습니다.이 메시지에는 식별자 필드가 누락되었거나 크기가 너무 큰 레코드 목록이 표시됩니다.
503Sendtric은 바쁘네요Retry-After 헤더에 명시된 초 수만큼 기다린 후, 동일한 요청을 다시 전송합니다.

요청에 포함된 레코드 중 일부만 유효하지 않은 경우, 유효한 레코드는 그대로 저장되고 나머지는 건너뜁니다.

기록을 확인해 보세요

데이터 출처를 열고 '레코드' 탭으로 이동합니다. 식별자 값으로 검색한 후 레코드를 클릭하면 Sendtric에 저장된 전체 JSON을 확인할 수 있습니다.

다음 단계

이 글이 도움이 되었나요?

이미지를 클릭하면 확대됩니다. 드래그하거나 스크롤해 둘러보세요.