본문으로 건너뛰기

공개 API

API 키를 만들고 스코프 고르기

키는 그것이 일할 워크스페이스에서 만들고, 연동에 필요한 스코프만 주고, 비밀로 보관하세요. 키는 한 번만 표시됩니다. 잃어버렸다면 폐기하고 새로 발급하세요.

절차

  1. 키가 건드릴 코드가 있는 워크스페이스 안에서 만듭니다. 키는 워크스페이스를 넘지 않습니다.
  2. 연동이 작동하는 선에서 가장 좁은 스코프를 줍니다. 읽기만 한다면 읽기 전용입니다.
  3. 키를 곧바로 자신의 비밀 보관소로 옮겨 적습니다.
  4. 클라이언트에 맞춰 Bearer 토큰이나 X-Mosaqo-API-Key 헤더로 인증합니다.
  5. 가능하면 주소로 제한하고, 정해진 주기로 교체합니다.

결과 확인 방법

/me 같은 신원 엔드포인트를 호출합니다. 기대한 워크스페이스가 돌아와야 하고, 그것으로 키가 어디에서 유효한지도 확인됩니다.

흔히 어긋나는 지점

  • 저장소에 커밋되거나 채팅에 붙여 넣은 키.
  • 모든 연동이 함께 쓰는 전능한 키 하나.
  • 엉뚱한 워크스페이스에서 만든 키. 모든 요청에 403을 돌려줍니다.
이 문서로 해결되었나요

도움이 되지 않았다면

플랫폼과 버전, 밟은 절차, 기대한 결과, 해당 워크스페이스나 QR 코드를 함께 적어 문의해 주세요. 무엇이든 첨부하기 전에 모든 비밀 정보를 가려 주세요.

지원팀에 문의