Skip to main content

다보리 API 설계의 기본 지식

  • 다보리 API 설계

  • HTTP

Method 및 보안성:
  • 다보리 ERP의 모든 API는 단순성과 보안성을 지향고려기 때문에 POST method만 사용합니다.
  • 이는 데이터 변경 및 전송의 안정성을 보장할 수 있습니다.

모든DaborySSO API는 GateToken을환경 변수:

  • DaborySSO를 사용하여 API 서버에 인증 및 권한 관리를 추천합니다. 그러나 필요에 따라 Key Pair를 API 서버의 환경 변수에 저장하여 SSO 서버와 독립적으로 사용할 수 있습니다.

GateToken:

  • API는모든 API 요청은 API 서버로부터 반환받은 GateToken을 포함해야 합니다. 이를 통해 인증 및 권한 부여가 이루어집니다.
  • GateToken은 타켓 DB의 접근 정보를 PKI 암호화한 BeforeBase64 Key로만 GateToken을 발급받을 수 있습니다. (이는 https://libsodium.gitbook.io/doc데이터 참조)
  • 보안을
  • DaborySSO 를 사용하기를 권장하지만 Key Pair를 API 서버의 환경변수에 저장하여 SSO 서버에 독립적으로 사용이 가능강화합니다.
  • 모든 Frontend Server는 ClientIdClientID 값을 가지며집니다. DaborySSO이는 DaborySSO에서 App 레코드를 만드생성하는 과정에서 생성이 가능합니다.
  • Client(Frontend)의 GateToken은 API 서버의 메모리 DB에 저장되며됩니다. 또한 유효기간 설정이 가능합니다.
이를
  • 사용자통해 인증 클라언트만이 API의API를 모든사용할 요청시 Gate Token가 Header에 포함되어야있도록 합니다.
  • 이러한 설계 원칙을 준수하여 안전하고 효율적인 API 시스템을 구축할 수 있습니다.