Blue API는 토큰 기반 인증 시스템을 사용합니다.
헤더
쿼리를 실행하기 전에 API 요청을 위한 헤더를 설정하는 것이 중요합니다. 이러한 헤더는 모든 요청에서 일관되게 유지되며, 한 번의 설정만 필요합니다. 이들은 API에 대한 각 요청을 인증하는 역할을 합니다.
필수 헤더는 Token-ID와 Secret-ID로, 각각 x-bloo-token-id
및 x-bloo-token-secret
로 표시됩니다.
추가로, 특정 요청은 더 구체적인 작업을 위해 Company-ID x-bloo-company-id
및 Project-ID x-bloo-project-id
의 포함이 필요할 수 있습니다.
토큰과 비밀을 생성하는 방법은 다음 비디오에서 배울 수 있습니다:
토큰 ID
토큰 ID는 API 접근을 위한 고유 식별자입니다.
API를 사용하려면 오른쪽 상단의 프로필을 클릭하고 프로필 메뉴 아래에서 API 탭을 찾으세요.
API 탭에서 "토큰 생성" 버튼을 클릭하세요:
토큰의 이름을 제공하고 원할 경우 만료 날짜를 설정하세요. 만료 날짜를 설정하면, API 토큰은 해당 날짜 이후에 자동으로 작동을 중지합니다.
생성 후, 토큰 ID와 비밀 ID가 표시됩니다. 토큰 ID는 쉽게 식별할 수 있도록 pat_
로 접두사가 붙습니다.
비밀 ID
비밀 ID는 비밀번호 역할을 하여 Blue의 API와의 안전한 통신을 보장합니다.
비밀 ID는 보안상의 이유로 한 번만 표시되므로, API를 통해 데이터에 접근할 수 있도록 안전하게 저장하세요. 최대 보안을 위해, Blue는 bcrypt 해싱을 사용하여 비밀을 저장하므로, 생성 후에는 우리 팀조차도 원문 비밀을 복구할 수 없습니다.
Token ID와 Secret ID를 안전하게 보관해야 합니다. 이러한 자격 증명에 접근할 수 있는 사람은 누구나 Blue의 데이터에 접근할 수 있습니다.
회사 및 프로젝트 ID
다음 비디오는 Blue에서 회사 ID와 프로젝트 ID를 찾는 방법을 보여줍니다:
회사는 Blue의 최상위 엔터티입니다. 회사 ID는 Blue에서 회사를 식별하는 데 사용됩니다. API에서 어떤 회사와 상호작용할지를 지정하는 데 사용됩니다. ID는 Blue에서 회사를 방문할 때 URL의 회사 슬러그와 동일합니다:
app.blue.cc/company/{company-id}/
특정 쿼리 및 변형을 위해서는 Project ID를 제공해야 합니다. 이는 상호작용하려는 프로젝트의 ID입니다. ID는 Blue에서 프로젝트를 방문할 때 URL의 프로젝트 슬러그와 동일합니다:
app.blue.cc/company/{company-id}/project/{project-id}/