API 사용하기
Last updated
Last updated
프릭스 API는 header의 x-api-key에 API key 값을 사용하여 호출할 수 있습니다.
프릭스 전자서명 키트 API를 이용하기 위해서는 프릭스 계정 생성이 필요합니다.
프릭스 서비스에 가입 후 로그인하면 API key를 발급 받을 수 있습니다. 자세한 발급 방법 및 API url 경로는 가입 후 문의주시면 별도로 안내드립니다.
계약서/전자서명 API를 사용하기 위해서는 비즈니스에 등록된 멤버와의 권한 연결이 필요합니다.
예를 들어 관리자 멤버와 권한을 연결하면 API는 관리자 권한을 갖고 요청을 수행하거나 목록을 조회할 수 있습니다.
비즈니스 페이지 팀/멤버 탭에서 권한을 연결할 멤버에 해당하는 ‘편집’ 버튼을 누르면 멤버 모달이 나타납니다.
나타나는 멤버 모달에서 ‘API 권한’에 ‘계약서’를 체크합니다.
프릭스 API를 호출하기 위해서는 발급받은 key를 header에 넣어서 사용하면 됩니다.
| Key | Description | Required |
|---|---|---|
x-api-key | 발급받은 API Key | yes |
| Status Code | Error Code | Description |
|---|---|---|
403 | FORBIDDEN_BUSINESS | API Key에 권한이 없는 비즈니스에 접근하는 경우 |
403 | NOT_MATCHES_PERMISSION_USER | API Key에 권한을 가진 사용자가 연결되어 있지 않은 경우 |
403 | FORBIDDEN_BUSINESS_KEY | API Key에 권한이 없는 경우 |
404 | NOT_FOUND_BUSINESS | API Key에 연결된 비즈니스가 없는 경우 |
500 | UNDEFINED_ERROR_CODE | 알 수 없는 에러가 발생한 경우 |
