온프레미스 API에 대한 지원을 중단합니다. 자세한 내용과 차세대 클라우드 API로 마이그레이션하는 방법을 알아보려면 온프레미스 API 지원 중단 문서를 참조하세요.
비즈니스 프로필 설정
/v1/settings/business/profile
/v1/settings/business/profile 엔드포인트를 사용하여 비즈니스 주소, 비즈니스 설명, 비즈니스 이메일 주소, 비즈니스 업종, 비즈니스 웹사이트로 구성된 비즈니스 프로필 설정을 구성합니다.
시작하기 전에
admin계정을 사용하여 비즈니스 프로필 설정에 액세스해야 합니다.
검색
GET API 호출을 보내서 비즈니스 프로필 설정을 검색합니다.
예
GET /v1/settings/business/profile
성공한 응답에는 비즈니스 프로필 데이터가 있는 profile 개체가 포함됩니다. 자세한 데이터 설명은 아래의 매개변수 리스트를 참조하세요.
{
"settings": {
"business": {
"profile": {
"address": "new-business-address",
"description": "business-description",
"email": "new-business-email",
"vertical": "business-industry",
"websites": [ "website-1", "website-2" ]
}
}
}
오류가 발생하면 오류 및 상태 메시지를 참조하세요.
비즈니스 프로필 설정 업데이트
POST API 호출을 보내서 비즈니스 프로필 설정을 업데이트합니다.
예
POST /v1/settings/business/profile
{
"address": "your-business-address",
"description": "your-business-description",
"email": "your-business-email",
"vertical": "your-business-industry",
"websites": [ "your-website-1", "your-website-2" ]
}
매개변수
| 이름 | 설명 |
|---|---|
유형: 문자열 | 비즈니스의 주소입니다. 최대 256자입니다. |
유형: 문자열 | 비즈니스에 대한 설명입니다. 최대 512자입니다. |
유형: 문자열 | 비즈니스에 연락하기 위한 이메일 주소(유효한 이메일 형식)입니다. 최대 128자입니다. |
유형: 문자열 | 비즈니스의 업종입니다. 다음의 허용되는 값 중 하나여야 합니다.
한 번 생성된 비즈니스 업종은 빈 값으로 되돌릴 수 없습니다. |
유형: 문자열 배열 | 비즈니스와 연결된 URL( |
부분 업데이트
새로운 정보로 몇 개의 필드만 업데이트해야 할 경우 필요한 필드만 변경하도록 요청할 수 있습니다.
POST /v1/settings/business/profile
{
"address": "new-business-address",
"email": "new-business-email"
}
요청이 성공하면 HTTP 상태 코드 200 OK와 null 또는 {}가 반환됩니다. 오류가 발생하면 오류 및 상태 메시지를 참조하세요.