API Reference

이싸인온 API

이싸인온에서 제공하는 모든 기능을 고객님이 사용하시는 환경에 쉽게 연동할 수 있는 API입니다.

  • 이싸인온 API는 API 요금제 구매 후 이용 가능합니다.
  • "TESTAPI"라는 공간에서 무료로 테스트를 제공하고 있습니다.

📢

"이싸인온 TESTAPI" 안내

이싸인온 TESTAPI는 이싸인온 API의 다양한 기능을 기간 제한없이 테스트하고 연동할 수 있는 공간입니다. TESTAPI를 이용하여 충분한 테스트를 진행하고 이싸인온 API를 체험해보세요.

이싸인온 TESTAPI 이용을 원하시면 아래 링크를 통해 문의해주세요.

이싸인온 고객문의 >

API 이용순서

이싸인온 API를 이용하시는 workflow는 아래와 같습니다.

  1. 이싸인온 회원가입
  2. API 요금제 구매
  3. 인증토큰 발급
  4. 인증토큰 이용하여 API 연동

❗️

인증토큰 입력 시 주의사항

토큰 발급을 제외한 모든 API에는 Header - Authorization 에 "eSignon 토큰 값"이 필요합니다.
Header에 입력하는 토큰은 아래의 이미지를 참조하여 esignon {token} 의 형태로 입력해주세요.

⚠️ esignon과 토큰 값 사이 띄어쓰기 주의

CompanyID

이싸인온 API 연동 시 자주 사용하는 CompanyID 값은 회사명이 아닌 회사 고유 ID❗ 입니다.

CompanyID 값을 확인하는 곳은 아래와 같습니다.

📌이싸인온 로그인 -> 설정 -> 회사 정보 -> CompanyID 확인 ☑️

회사 정보는 Company Leader만 확인 가능합니다.

API 요청 제한

이싸인온 API는 안정적인 서비스 운영을 위해 Rate Limit을 초과하는 호출이 발생하는 경우 해당 요청이 실패 처리됩니다. 시간이 지나면 다시 호출 요청 횟수가 갱신되며, 호출 요청 횟수 제한은 아래와 같습니다.

🚧

API 호출 요청 횟수 제한

원활한 서비스 제공을 위하여 과도한 API 사용은 예고 없이 제한될 수 있습니다.

  • 분당 300건
  • 시간당 10,000건

API 사용 제한 정보 확인

안정적인 API 운영을 위해, API 사용 시 아래 header 파라미터를 통해 남은 호출 수 또는 재설정 대기 시간을 확인할 수 있습니다.

Rate limit HTTP headers

Header NameDescription
X-Rate-Limit-Remaining분당 제한 되는 남은 호출 수
X-Rate-Limit-Retry-After-Seconds제한 된 호출 수의 재설정까지 남은 시간