SaaS API
콘텐츠 가이드라인 API
기업 대시보드용 콘텐츠 가이드라인 관리 API
콘텐츠 가이드라인 API
기업 대시보드에서 사용하는 콘텐츠 가이드라인 관련 API입니다.
Base URL: /ai/guideline
인증 정보
| 항목 | 값 |
|---|---|
| 인증 필요 | 예 |
| 인증 방식 | JWT Bearer Token |
엔드포인트 목록
가이드라인 CRUD
| 메서드 | 경로 | 설명 | 인증 |
|---|---|---|---|
GET | /ai/guideline/{collabNo} | 가이드라인 조회 | 필요 |
DELETE | /ai/guideline/{collabNo} | 가이드라인 삭제 | 필요 |
POST | /ai/guideline/{collabNo}/guideline/complete | 가이드라인 완료 | 필요 |
이미지 업로드
| 메서드 | 경로 | 설명 | 인증 |
|---|---|---|---|
POST | /ai/guideline/{collabNo}/images | 이미지 업로드 | 필요 |
기본값 조회
| 메서드 | 경로 | 설명 | 인증 |
|---|---|---|---|
GET | /ai/guideline/guideline/defaults/brand-account | 기본 브랜드 계정 조회 | 필요 |
GET | /ai/guideline/guideline/defaults/brand-logo | 기본 브랜드 로고 조회 | 필요 |
옵션 템플릿
| 메서드 | 경로 | 설명 | 인증 |
|---|---|---|---|
GET | /ai/guideline/guideline/templates | 전체 옵션 템플릿 조회 | 불필요 |
GET | /ai/guideline/guideline/templates/options | 촬영/마케팅 옵션 조회 | 불필요 |
API 상세
가이드라인 조회
캠페인의 콘텐츠 가이드라인을 조회합니다.
HTTP 요청
GET /ai/guideline/{collabNo}
Authorization: Bearer {access_token}Path Parameters
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
collabNo | int | 예 | 캠페인 번호 |
응답
성공 응답 (200 OK)
{
"status": 200,
"code": null,
"message": "가이드라인 조회가 완료되었습니다.",
"data": {
"guidelineId": 1,
"collabNo": 123,
"brandInfo": {
"brandName": "글로브 뷰티",
"brandLogo": "https://..."
},
"contentRequirements": {
"platform": "INSTAGRAM",
"contentType": "REEL",
"duration": "30-60초"
},
"shootingOptions": [...],
"marketingOptions": [...]
}
}가이드라인 삭제
캠페인의 콘텐츠 가이드라인을 삭제합니다.
HTTP 요청
DELETE /ai/guideline/{collabNo}
Authorization: Bearer {access_token}응답
성공 응답 (200 OK)
{
"status": 200,
"code": null,
"message": "가이드라인이 삭제되었습니다.",
"data": null
}가이드라인 완료
가이드라인 작성을 완료하고 PDF를 생성합니다.
HTTP 요청
POST /ai/guideline/{collabNo}/guideline/complete
Authorization: Bearer {access_token}응답
성공 응답 (200 OK)
{
"status": 200,
"code": null,
"message": "가이드라인이 완료되었습니다.",
"data": {
"pdfUrl": "https://..."
}
}이미지 업로드
가이드라인 및 캠페인용 이미지를 업로드합니다.
HTTP 요청
POST /ai/guideline/{collabNo}/images
Authorization: Bearer {access_token}
Content-Type: multipart/form-dataQuery Parameters
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
type | string | 예 | 이미지 타입 |
이미지 타입
| 타입 | 설명 |
|---|---|
brand-logo | 브랜드 로고 (캠페인 소유 기업 기준 저장) |
thumbnail | 썸네일 이미지 |
detail | 상세 이미지 (단일/복수 가능) |
Request Parts
| 파트 | 타입 | 필수 | 설명 |
|---|---|---|---|
files | file[] | 예 | 업로드할 이미지 파일들 |
응답
성공 응답 (200 OK)
{
"status": 200,
"code": null,
"message": "이미지 3개가 업로드되었습니다.",
"data": [
{
"fileUrl": "https://s3.../image1.jpg",
"fileName": "product1.jpg",
"type": "detail",
"order": 1
},
{
"fileUrl": "https://s3.../image2.jpg",
"fileName": "product2.jpg",
"type": "detail",
"order": 2
}
]
}기본 브랜드 계정 조회
기업이 이전에 저장한 기본 브랜드 계정 정보를 조회합니다.
HTTP 요청
GET /ai/guideline/guideline/defaults/brand-account
Authorization: Bearer {access_token}기본 브랜드 로고 조회
기업이 이전에 저장한 기본 브랜드 로고 URL을 조회합니다.
HTTP 요청
GET /ai/guideline/guideline/defaults/brand-logo
Authorization: Bearer {access_token}전체 옵션 템플릿 조회
가이드라인 작성에 필요한 플랫폼, 카테고리, 콘텐츠 컨셉 목록을 조회합니다.
HTTP 요청
GET /ai/guideline/guideline/templates응답
성공 응답 (200 OK)
{
"status": 200,
"code": null,
"message": "옵션 템플릿 조회가 완료되었습니다.",
"data": {
"platforms": [
{"code": "INSTAGRAM", "name": "인스타그램"},
{"code": "YOUTUBE", "name": "유튜브"}
],
"categories": [
{"code": "BEAUTY", "name": "뷰티"},
{"code": "FASHION", "name": "패션"}
],
"contentConcepts": [...]
}
}촬영/마케팅 옵션 조회
플랫폼, 콘텐츠 타입, 카테고리에 맞는 촬영 옵션과 마케팅 옵션을 조회합니다.
HTTP 요청
GET /ai/guideline/guideline/templates/options?platformCode={platform}&contentTypeCode={contentType}&categoryCode={category}Query Parameters
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
platformCode | string | 예 | 플랫폼 코드 (예: INSTAGRAM) |
contentTypeCode | string | 예 | 콘텐츠 타입 코드 (예: REEL) |
categoryCode | string | 예 | 카테고리 코드 (예: BEAUTY) |
응답
성공 응답 (200 OK)
{
"status": 200,
"code": null,
"message": "옵션 조회가 완료되었습니다.",
"data": {
"shootingOptions": [
{"code": "PRODUCT_SHOT", "name": "제품 샷"},
{"code": "LIFESTYLE", "name": "라이프스타일"}
],
"marketingOptions": [
{"code": "DISCOUNT_CODE", "name": "할인 코드 노출"},
{"code": "SWIPE_UP", "name": "스와이프 업 링크"}
]
}
}사용 예시
이미지 업로드
curl -X POST "https://api.glowb.io/ai/guideline/123/images?type=detail" \
-H "Authorization: Bearer {token}" \
-F "files=@product1.jpg" \
-F "files=@product2.jpg"옵션 템플릿 조회
curl -X GET "https://api.glowb.io/ai/guideline/guideline/templates/options?platformCode=INSTAGRAM&contentTypeCode=REEL&categoryCode=BEAUTY"