개요

• 데이터브러쉬의 API 사용에 관한 문서입니다.
• API 를 활용하면 템플릿만 제작한 후, Google Sheet 연동 없이 이미지를 생성할 수 있습니다.

RESTful API

API key 발급

• Databrush API key는 대시보드의 API 설정 페이지에서 발급받을 수 있습니다.

  

템플릿 메타데이터 확인

• Databrush 에디터에서 템플릿을 제작하거나 수정한 후, 해당 템플릿에 대한 메타데이터를 체크하여 어떤 정보를 넣을 지 결정할 수 있습니다.

• 사용자가 생성하거나 복사한 템플릿 (내 템플릿 페이지에 있는 템플릿들) 에 대해서만 생성할 수 있습니다.

• 먼저 template ID 값을 확인합니다.

  

  • template ID 값은 에디터에 들어갔을 때 URL의 마지막 값으로 확인 가능합니다.
  • 위의 예시의 경우 editor/ 뒤에 있는 608143cda702927c1f7a403c 값이 template ID 입니다.

• Request 예시

  curl -i -X GET \\
     -H "X-Client-Id:databrush-client-prod" \\
     -H "Api-Key:{API_KEY}" \\
   '<https://app.databrush.io:8443/v1/templates/{TEMPLATE_ID}/metadata>'
  

  • Request 는 HTTP GET 이며, 헤더에 반드시 client id 와 api key 를 포함해야 합니다.

• Response 예시

  [
  	{
  		"objectName": "png_이미지",
  		"type": "IMAGE_URL",
  		"objectNamePostfix": "🎨🔗(URL)",
  		"headerName": "🎨🔗(URL) png_이미지"
  	},
  	{
  		"objectName": "png_이미지",
  		"type": "IMAGE_FIT_TYPE",
  		"objectNamePostfix": "🎨(정렬 타입)",
  		"headerName": "🎨(정렬 타입) png_이미지"
  	},
  	{
  		"objectName": "png_이미지",
  		"type": "IMAGE_ANCHOR_X",
  		"objectNamePostfix": "🎨(X축 정렬)",
  		"headerName": "🎨(X축 정렬) png_이미지"
  	},
  	{
  		"objectName": "png_이미지",
  		"type": "IMAGE_ANCHOR_Y",
  		"objectNamePostfix": "🎨(Y축 정렬)",
  		"headerName": "🎨(Y축 정렬) png_이미지"
  	},
  	{
  		"objectName": "로고",
  		"type": "IMAGE_URL",
  		"objectNamePostfix": "🎨🔗(URL)",
  		"headerName": "🎨🔗(URL) 로고"
  	},
  	{
  		"objectName": "로고",
  		"type": "IMAGE_FIT_TYPE",
  		"objectNamePostfix": "🎨(정렬 타입)",
  		"headerName": "🎨(정렬 타입) 로고"
  	},
  	{
  		"objectName": "로고",
  		"type": "IMAGE_ANCHOR_X",
  		"objectNamePostfix": "🎨(X축 정렬)",
  		"headerName": "🎨(X축 정렬) 로고"
  	},
  	{
  		"objectName": "로고",
  		"type": "IMAGE_ANCHOR_Y",
  		"objectNamePostfix": "🎨(Y축 정렬)",
  		"headerName": "🎨(Y축 정렬) 로고"
  	},
  	{
  		"objectName": "메인텍스트",
  		"type": "TEXT",
  		"objectNamePostfix": "🖊(텍스트)",
  		"headerName": "🖊(텍스트) 메인텍스트"
  	},
  	{
  		"objectName": "서브텍스트",
  		"type": "TEXT",
  		"objectNamePostfix": "🖊(텍스트)",
  		"headerName": "🖊(텍스트) 서브텍스트"
  	},
  	{
  		"objectName": "할인율",
  		"type": "TEXT",
  		"objectNamePostfix": "🖊(텍스트)",
  		"headerName": "🖊(텍스트) 할인율"
  	}
  ]
  

  • Response는 json array 이며, 해당 템플릿을 이용하여 이미지를 생성할 때 필요한 파라미터를 리턴하게 됩니다.