스니핏 API로 각 플랫폼의 광고와 게시물 소재를 검색할 수 있습니다. 워크스페이스에 저장한 브랜드의 소재와 보드를 다루거나 조회할 수도 있습니다.
이 문서는 결제 수단 등록부터 첫 요청을 보내기까지의 과정을 안내합니다.
API는 Scale 플랜을 사용하는 워크스페이스에서만 이용할 수 있습니다.
결제 수단 등록과 API 키 발급은 워크스페이스 소유자와 관리자만 할 수 있습니다.
개발자 콘솔의 결제에서 결제 수단을 등록하세요. API 요금은 플랜 요금과 별도로, 미리 충전한 달러 잔액에서 차감됩니다. 자세한 내용은 요금을 참고하세요.
개발자 콘솔의 API 키에서 키 만들기를 누르고 키 이름을 입력합니다.
키 원문(snp_live_로 시작)은 만들 때 한 번만 표시됩니다. 창을 닫기 전에 안전한 곳에 저장하세요. 키를 다루는 방법은 인증을 참고하세요.
먼저 GET /v1/usage로 키가 동작하는지 확인합니다. 이 요청은 금액이 차감되지 않으며, API 잔액과 브랜드 슬롯을 반환합니다.
200 응답을 받으면 키가 정상입니다. 401이면 키 값과 헤더 형식을, 403이면 키를 만든 사람이 아직 워크스페이스에 있는지 확인하세요.
소재 검색 엔드포인트로 첫 검색을 보내 봅니다. 예시의 snp_live_xxxxxxxxxxxxxxxx 자리에 발급받은 키를 넣으세요.
요청이 성공하면 다음과 같은 응답이 반환됩니다. 예시는 일부 필드를 생략했습니다.
필드 | 설명 |
|---|---|
data | 검색 결과 목록입니다. 항목 하나가 소재 하나입니다. |
data[].creative_id | 소재 ID입니다. |
data[].media | 이미지·영상 썸네일(캐러셀 순서, WebP)입니다. |
data[].organic | 게시물 반응입니다. 숫자의 |
pagination.next_cursor | 다음 페이지를 요청할 때 쓰는 값입니다. 마지막 페이지면 |
usage.cost_micro_usd | 이 요청에서 차감된 금액입니다. 마이크로달러(1달러 = 1,000,000)입니다. |
usage.balance_micro_usd | 이 요청을 처리한 뒤 남은 잔액입니다. |
pagination.has_more가 true이면 다음 페이지가 있습니다. 첫 요청과 같은 파라미터에 cursor=<next_cursor>만 추가해 보내세요. 다른 파라미터를 바꾸면 422 오류가 반환됩니다.
소재 검색은 한 페이지가 20건이고 limit은 받지 않습니다. 다른 파라미터를 바꾸면 422 오류가 반환됩니다.
호출 | 비용 |
|---|---|
소재 검색, 유사 소재 검색 | $0.05 |
영상 검색 | $0.10 |
그 외 호출 | $0.01 |
GET /v1/usage | 무료 |
다음 페이지 요청에도 같은 금액이 차감됩니다. 결과가 없고 다음 페이지도 없으면 차감되지 않습니다.
응답 헤더로 다음 값을 확인할 수 있습니다.
헤더 | 설명 |
|---|---|
X-Cost-Micro-Usd | 이 요청에서 차감된 금액 (본문 |
X-Balance-Micro-Usd | 요청을 처리한 뒤 남은 잔액 (본문 |
X-Request-Id | 요청 ID (본문 |