토핑 - 개발 문서

Basic 인증 방식은 HTTP의 기본 인증 방식 중 하나로,
클라이언트에서 base64로 인코딩된 사용자명/비밀번호 쌍을 자격 증명(credentials) 값으로 사용합니다.
사용자명과 비밀번호는 콜론으로 구분해서 {USERNAME}:{PASSWORD}로 넣어줍니다.
토핑은 사용자명에 시크릿 키를 넣어 사용하고, 비밀번호는 사용하지 않습니다.
따라서 아래와 같이 발급받은 시크릿 키에 콜론을 합친 {SECRET_KEY}:을 base64로 인코딩한 값을 넣어주면 됩니다.

요청

cURL

curl --request POST \
--url https://topping.place/api/public/story/{USER_ID} \
--header 'Authorization: Basic base64({SECRET_KEY}:)' \
--header 'Content-Type: application/json' \
--data '{"title":"Test Story", "content":"Test Story Content"}'

다음과 같은 응답을 확인하실 수 있습니다.

이미지 업로드 URL

응답의 image.profile, image.banner는 이미지 업로드용 일회성 URL입니다.
일회성이며, 최대 30분간 유효합니다.
이미지는 PNG, JPEG, GIF, WebP, SVG 중 하나여야 하며, 10MB 이하여야 합니다.

이미지 업로드 형식을 반드시 준수하세요

이미지는 formData에 담아 업로드해야 하며,
formData 이미지 이름은 반드시 다음 예시와 같아야 합니다.

이미지가 PNG 형식인 경우, 다음과 같습니다.
story-{STORY_ID}-profile.png
story-{STORY_ID}-banner.png

이 형식을 준수하지 않은 경우 무통보 이미지/스토리 삭제, 계정 정지 처리가 이루어지므로 주의하시기 바랍니다.

응답

JSON

{
"success" : true,
"story" : {
"id" : 1
},
"image" : {
"profile" : "https://upload.imagedelivery.net/xxxxxxx"
"banner" : "https://upload.imagedelivery.net/xxxxxxx"
}
}

더 궁금한 내용이 있나요?

서비스

지원