Apidog API 문서 접근 제어 5가지 쉬운 방법

API 문서를 작성하고 게시할 준비를 마친 후, 핵심 질문이 떠오릅니다: 누가 이 문서를 볼 수 있어야 하는가?

문서가 완전히 공개되어야 할까요? 아니면 내부 팀에게만 제한되어야 할까요? 어쩌면 외부 파트너가 접근해야 할 수도 있지만, 아무나 접근해서는 안 될 수도 있습니다.

각 시나리오별로 별도의 문서 버전을 만드는 것은 시간 소모적이고 비효율적입니다. 실제로는 접근 요구 사항이 매우 구체적인 경우가 많습니다. 예를 들어, 특정 부서만 볼 수 있거나, 파트너가 회사 네트워크 내에서만 접근할 수 있도록 해야 할 수도 있습니다.

다행히도, Apidog는 이러한 모든 요구를 충족하는 다양한 접근 제어 옵션을 제공합니다. 문서 사이트를 게시할 때, 사용 사례에 맞는 접근 제어 방식을 선택하기만 하면 됩니다.

1. 공개: 누구나 볼 수 있음

제품의 공개 API처럼 API가 공개적으로 사용될 수 있는 경우, 접근 제어를 "공개"로 설정하기만 하면 됩니다. 링크를 가진 누구든지 문서를 볼 수 있습니다.

전문가 팁: Apidog는 개발자들이 API를 찾아보고 발견할 수 있는 마켓플레이스 스타일의 플랫폼인 API 허브도 제공합니다. 가시성과 채택률을 높이려면 여기에 문서를 게시하세요.

때로는 문서를 완전히 공개하고 싶지 않지만 복잡한 설정도 피하고 싶을 수 있습니다. 비밀번호 보호는 간단한 해결책입니다. 비밀번호를 설정하면, 아는 사람만 문서에 접근할 수 있습니다.

설정은 쉽습니다:

가장 적합한 경우: 파트너가 API 디자인을 검토하도록 하는 것과 같이 단기 또는 임시 공유에 적합합니다. 그 후에는 비밀번호를 업데이트하거나 문서를 게시 취소하기만 하면 됩니다. 간단하고 깔끔합니다.

하지만 명심하세요: 비밀번호는 의도치 않게 공유될 수 있습니다. 더 엄격한 제어가 필요하다면 다른 옵션을 고려하세요.

팀이나 파트너가 고정된 사무실 위치에 기반을 둔 경우, IP 허용 목록이 최선의 선택일 수 있습니다.

작동 방식은 다음과 같습니다:

문서의 방화벽이라고 생각하세요.

가장 적합한 경우:

단일 IP 또는 전체 IP 범위를 구성할 수 있습니다.

보너스: Apidog의 팀 설정에서 팀 프로젝트 접근에 대한 IP 허용 목록을 활성화할 수도 있습니다 (엔터프라이즈 플랜 필요). 활성화되면 허용된 IP의 사용자만 내부 프로젝트에 접근할 수 있습니다.

비밀번호가 유출되거나 IP가 자주 변경될까봐 걱정되시나요? 이메일 허용 목록은 유연하고 안전한 대안입니다.

팀이나 파트너의 이메일 주소를 허용 목록에 추가하기만 하면 됩니다. 그러면 사용자는 일회성 이메일 인증 코드를 통해 문서에 접근할 수 있습니다.

또한 와일드카드도 지원합니다. 예를 들어, *@apidog.com은 회사 도메인을 가진 모든 사용자가 문서에 접근할 수 있도록 허용합니다.

장점:

위의 방법 중 어느 것도 요구 사항을 충족하지 못한다면, 더 고급 옵션인 사용자 정의 로그인 페이지가 있습니다. 이를 통해 자체 인증 시스템을 연결하여 접근을 제어할 수 있습니다.

작동 방식은 다음과 같습니다:

이 접근 방식은 비즈니스 요구에 따라 정확하게 권한을 정의할 수 있도록 합니다. 개발이 필요하지만, 복잡한 접근 제어 요구 사항을 가진 회사에 매우 적합합니다.

사용자 정의 로그인 페이지 구현에 대한 자세한 내용은 도움말 문서를 참조하세요.

너무 많은 옵션 중에서 다음과 같이 궁금할 수 있습니다: 어떤 것을 선택해야 할까요?

사용 사례에 따라 다릅니다:

팁: 여러 방법을 조합할 수 있습니다. 예를 들어:

Apidog를 사용하면 여러 문서 사이트를 게시할 수 있으며, 각 사이트에는 자체 접근 제어 및 맞춤형 API 엔드포인트 세트가 있습니다. 이는 다양한 대상이 필요한 것만 볼 수 있도록 하여, 그 이상도 이하도 아님을 의미합니다.

버튼