<aside> 💡 Lemonbase OpenAPI의 사용 설명서 입니다. 🚨 표시가 있는 경우, 연동 시 특히 주의 해야 할 부분입니다. 일부 API 사용 시, 호출 순서나 사전에 값 입력 등이 필요할 수 있습니다.

</aside>

공통

• 모든 API URL의 끝에는 Slash/ 를 붙여야 합니다.

• PUT method의 경우, 변경할 값을 제외한 유지하려는 값은 모두 키와 함께 전달해야 합니다.

  • 예) 기존 조직 명이 레몬베이스 1팀 에서 레몬베이스 2팀 으로 변경하려는 경우

  {
      "name": "레몬베이스 2팀", // 변경하려는 부분
      "code": "기존_등록한_조직_코드", // 기존의 값과 동일
      "parent_organization_code": "기존_사용한_상위_조직_코드" // 기존의 값과 동일
  }
  

• API 문서의 Request Body의 각 필드에서required 표시가 된 항목은 반드시 넣어주어야 합니다.

구성원(person) 연동 시 주의사항

• 구성원 추가 시, 주 조직main_organization, 겸직 조직sub_organizations 에 사용하는 조직 코드는 레몬베이스에 저장되어 있는 조직에 한하여 가능합니다.
  • 🚨 미리 추가하지 않은 조직의 조직 코드는 사용할 수 없습니다.
• employee_number는 기존에 등록된 구성원과 겹치지 않아야 합니다.

조직(organization) 연동 시 주의사항

• 조직 추가 시, 구성원의 이메일 또는 Entity ID를 이용하여 조직 리더를 설정할 수 있습니다.
  • 🚨 조직에 추가할 수 있는 조직 리더는 레몬베이스에 저장되어 있는 구성원이 아닌 경우 사용할 수 없습니다.
• 조직 코드는 모두 unique 로 입력해야 합니다.
• 조직 리더를 설정할 경우, 해당 리더가 리더로 설정할 조직의 구성원이 아니더라도 조직 리더 역할을 할 수 있습니다(구성원은 아니지만, 조직의 리더를 맡는 형태).
  • 사외 이사나 컨설팅 자문으로 임시로 해당 팀의 리더만 맡는 경우
• leader의 경우, key가 없을 경우 기존값 유지, key가 있고 value에 null일 경우 조직 리더 초기화, value가 특정 구성원의 이메일일 경우 조직 리더로 설정됩니다.

/bulk API 사용 시 주의사항

<aside> 💡 /bulk API는 현재 person(구성원), organization(조직)에서 제공하고 있습니다.

</aside>

• /bulk API를 사용하여 구성원 또는 조직 정보를 추가/갱신할 경우, 위 사항을 고려하여 API 호출 순서를 지켜야 합니다.
  • 추천 연동 방법
    1. organization /bulk API를 통해 대량의 조직 정보를 추가/갱신합니다. 이 때, leader 값은 추가하지 않은 상태로 입력합니다.
    2. person /bulk API를 통해 대량의 구성원 정보를 추가/갱신합니다.
    3. 조직 리더로 지정할 값을 organization /bulk API를 통해 추가/갱신합니다.
• /bulk API 사용 시, 한 번에 처리하는 데이터의 양은 다음을 권장합니다.
  • persons/bulk : 최대 1000명
  • organizations/bulk : 최대 100개
  • 위의 명시한 건수를 초과할 경우, 서버 요청 후 응답 시간이 느려지거나, Request body의 최대 가능 크기를 초과하여 정상 응답을 받지 못할 수 있습니다.
• 데이터를 업데이트 하는 경우
  • 기존에 입력된 구성원 정보를 유지하려면 Request Body 에 입력을 유지하고자 하는 key와 값을 빼고 요청합니다.
    • 사용 예시
  • 기존에 입력된 구성원 정보를 지우려면 Request Body 에 변경하고자 하는 key와 null을 값에 넣고 요청합니다.
    • 사용 예시
  • 겸직 조직sub_organizations 의 경우, 빈 리스트([]) 나 null을 value로 입력할 경우, 겸직조직의 소속에서 제외됩니다.
    • 만약, 기존 A, B, C 조직에 속한 상태에서 추가로 D 조직도 겸직 조직으로 원할 경우, 조직 코드를 A, B, C, D 모두 입력해주어야 합니다.