BSSM Developers 사용 가이드 - API 사용
본 가이드에서는 BSSM Developers 서비스에서 API 사용에 관해 다루고 있습니다.
잘 읽어주세요 :)
시작하기
BSSM Developers에는 학생들이 등록한 다양한 API를 사용 신청을 통해 사용할 수 있어요.
API 사용 신청을 위해서는 먼저 토큰을 발급 받아야해요.
토큰 발급
메인 페이지 -> 마이페이지 -> 내 토큰 관리 페이지에 들어오면 자신의 토큰들을 관리할 수 있어요.
토큰은 BSSM Developers에서 API 사용을 할때 반드시 필요해요.
새로운 토큰을 발급 받고 싶다면 신규 토큰 발급 버튼을 눌러 발급 받을 수 있어요.
먼저 발급 할 토큰의 이름과 허용할 origin 도메인을 입력해주세요.
토큰의 이름과 origin은 발급 받은 이후에 수정할 수 있어요.
입력이 끝나면 토큰을 발급 받을 수 있어요.
토큰이 발급되면 클라이언드 ID와 시크릿 키가 함께 제공돼요.
클라이언트 ID는 이후에 다시 확인할 수 있지만, 시크릿 키는 처음 발급 받은 화면에서만 확인할 수 있으니 꼭 보관해주세요.
(시크릿 키는 서버에서 API를 사용할 때만 사용해요)
API 사용 신청
BSSM Developers에는 학생들이 등록한 다양한 API들이 많아요.
사용하고 싶은 API를 골라 신청할 수 있어요.
원하는 API 문서에서 사용 신청 버튼을 클릭하면 모달이 나와요.
신청 모달에는 신청할 API, 사용할 토큰과 사용 목적을 입력해야해요.
사용 목적은 해당 API 관리자가 확인할 수 있으니 잘 작성해주세요.
API를 등록한 사람이 API 사용 신청을 승인하면 API를 사용할 수 있게 돼요.
내가 신청한 API 현황을 보고 싶다면 마이페이지 -> 내 토큰 관리 페이지에서 확인할 수 있어요.
API 사용 - 클라이언트
이제 승인 받은 API를 사용할 수 있어요.
클라이언트에서는 header에 토큰을 붙여 proxy로 요청을 보내는 방식으로 사용할 수 있어요.
아래의 예시 코드를 참고하여 API를 자유롭게 사용해주세요!
class BssmDevelopersAdapter {
constructor() {
this.instance = axios.create({
baseURL: 'https://proxy.bssm-dev.com',
headers: {
'bssm-dev-token': 'd451a083-c4f0-4675-a45f-d95c5c597bb5',
},
});
}
async get(url, config) {
const response = await this.instance.get(url, config);
return response.data;
}
}
export const bssmDevelopersAdapter = new BssmDevelopersAdapter();API 사용 - 서버
이제 승인 받은 API를 사용할 수 있어요.
서버에서는 header에 토큰과 시크릿 키를 담아 proxy로 요청을 보내는 방식으로 사용할 수 있어요.
아래의 예시 코드를 참고하여 API를 자유롭게 사용해주세요!
async def get_github_repos(user_id: str):
profile_url = f"https://proxy.bssm-dev.com/users/{user_id}"
try:
profile = fetch_json(
url=profile_url,
headers={
"bssm-dev-token": "da7a22e3-a631-454a-b138-5532397f13bf",
"bssm-dev-secret": "ae299e4b0dd145e18e031adc8b325314",
}
)