BrandMeister의 Users API keys 사용법

[HL4BPL]

BrandMeister dashboard에 로그인하면 나오는 첫 화면에 소개하고 있는 2018년 3월 10일자 News인 BrandMeister의 Users

API keys 관련 내용을 번역 및 정리해 보겠습니다.

-----------------------------------------------------------------------------

BrandMeister는 Users API keys를 자랑스럽게 소개합니다!

사용자 API key 가 무엇이지요?

BrandMeister 사용자 API key는 제3자 응용프로그램들이 사용자의 SelfCare 정보 및 기능들과 상호작용할 수 있게 해줍니다.

예를 들어, BrandMeister 사용자는 자신의 BrandMeister 개인 Self-Care 및 repeaters를 살펴보고 변경하도록 자신의 API

key를 휴대폰 앱에게 제공해 줄 수 있습니다.   사용자 이름 (호출부호) 및 암호를 알려줄 필요가 없습니다.

API key는 어떻게 생겼나요?

API key는 128개의 문자열입니다.   예를 들면;
MWaztB3EcHWBEW@D$2gb89Y2kvvE4leSr.33Gey74d0IYVSKU58YGMSFmPHD.Q1fECUkIcj7E4leSr.33Getkjshdf987ywe2irl

igr908SFIdlsfkj08934sasdlveg

왜 API key를 사용하지요?

API key를 사용하면 여러분의 SelfCare 사용자 이름과 암호를 비밀로 할 수 있고, 여러분이 다른 이에게 제공하는 각 key에

대해 세부적인 제어를 할 수 있습니다.

API key는 여러분의 SelfCare 암호와 전혀 관련되어 있지 않습니다.   여러분이 여러분의 SelfCare 암호를 변경해도, 여러분이

만들었던 key들은 여전히 유효합니다.

아무 때나 여러분은 key를 취소할 수 있고, 이 key를 가지고 있는 어떤 사람 또는 응용프로그램도 여러분의 개인 SelfCare

계정의 정보 및 기능들을 더 이상 액세스할 수 없습니다.

내 사용자 API Key들을 어떻게 만들고 또 취소하지요?

API Key를 생성하려면, 다음 단계를 따릅니다;

1) 웹브라우저를 사용해 여러분의 BrandMeister SelfCare 계정에 로그인 합니다.   그리고 여러분의 호출부호 및 암호로

인증합니다.

2) 화면 상단의 여러분의 호출부호 또는 아바타를 클릭하고, “Profile Settings”를 선택합니다.

3) Security Settings 부분에 있는 “API Keys”를 클릭합니다.

4) 여기가 여러분의 기존 key들 (만일 있다면)이 표시되는 곳입니다.   새로운 key를 만들기 위해 “Add”를 클릭합니다.

5) API key 에 이름을 줍니다.
여러분은 원하는 만큼의 키들을 생성할 수 있습니다.   따라서 여러분이 사용할 응용프로그램당 하나씩의 키를 만들고 각기

이름을 정합니다.   이름은 키에 아무런 영향을 주지않고, SelfCare 에서 어떤 key가 어떤 것인지 기억하는데 도움을 줄

이름표일 뿐입니다.

6) 다음 화면은 API 키를 표시합니다.   여러분이 휴대폰 앱에 API key를 설정한다면, 앱 안에서 key의 QR코드 사진을 찍어서

입력할 수 있는 기회입니다.   그렇지 않다면, 응용프로그램으로 직접 복사/붙여넣기를 할 수 있습니다.

지금이 key 코드 및 QR코드를 볼 수 있는 유일한 시간입니다.   한 번 “OK”를 클릭해 버리면 단지 key 이름만 목록에 남습니다.

여러분은 언제라도 취소하고 새로운 key를 만들 수 있으므로, key의 복사본을 다른 곳에 보관할 필요가 없습니다.

여러분의 key를 누구에게 주었는지, 그리고 어디에 key를 저장했는지 특히 주의하기 바랍니다.  

Key는 여러분의 SELFCARE의 모든 기능들에 대한 완전한,그리고 모든 액세스를 허용합니다.  

이것은 리피터/마스터 SYSOP 기능들까지 포함합니다!

7) “OK”를 클릭한 후, API key 목록 화면으로 되돌아올 것입니다.   필요하면 여기에서 key를 취소(revoke)할 수도 있습니다.

단순히 계정 자격을 제공해주면 되는 것 아닌가요?

여러분의 암호는 비밀이고, 다른 이에게 절대 주어서는 안됩니다.   별도의 key를 제3자에게 제공해주므로써 더 나은 제어를

할 수 있습니다.   만일 여러분의 계정 암호를 알려주었다고 한다면, 암호를 변경하고자 할 때마다 제3자들에게 각 각 가서

업데이트를 해야할 것입니다.   API key를 사용함으로써, 어러분이 이미 제공한 다른 키들에 영향을 미치지 않고 여러분의

SelfCare 계정 암호를 바꿀 수 있고, 어떤 key를 취소할 수 있습니다.

API key를 사용하는 기존의 응용프로그램이 있습니까?

현재 사용자 API key를 사용하는 첫 번째 응용프로그램을 개발하는데 우리와 함께 작업한 세명의 개발자가 있습니다;

1) BrandMeister Tool (Android) (M0PFX)

이 안드로이드 장치용 응용프로그램은 웹기반 SelfCare 인터페이스를 통하지않고 여러분의 휴대장치에서 직접 여러분의

hotspot 또는 리피터를 관리할 수 있게 해줍니다.   한 번만 여러분의 사용자 API key를 등록해주면, 더 이상 암호가 필요

없습니다.  

그리고 여러분이 웹기반 인터페이스를 사용해 여러분의 SelfCare 암호를 변경해도 프로그램은 계속 작동되고 여러분의

SelfCare 계정에 올바르게 인증됩니다.

2) Pi-Star (MW0MWZ)

Pi-Star는 Raspbian linux 위에 만들어진 라즈베리파이용 주문형, 미리 설정된 SD 카드 이미지입니다.   이것은 G4KLX에

의한 소프트웨어 스택, MMDVMHost / DStarRepeater 그리고 관련 도구와 프로그램들을 포함하고 있습니다.

이것의 내장 대시보드는 이제, API 사용의 덕으로 사용자의 BrandMeister 설정을 변경할 수 있는 능력을 갖추었습니다.

관련 문서 

3) Repeater Reader (DO1JG)

Repeater Reader는 선택된 리피터 또는 Hotspot에 대한 가시성과 관리 옵션을 생성하는 작은 JAVA 응용프로그램입니다.

이것은 또한 API들을 통하여 리피터를 제어하는 지원을 합니다.

BrandMeister 팀은 이러한 모든 것이 되도록 한데에 대해 모든 응용프로그램 개발자들에게 감사드립니다.

-----------------------------------------------------------------------------------------------------------

여기까지가 BM 대시보드의 News 내용입니다.

다음은, 위의 내용중 Pi-Star 관련 문서 내용입니다.

-------------------------------------------

BrandMeister API 를 Pi-Star에 내장하기
-------------------------------------------
BrandMeister API 내장
-------------------------------------------

Pi-Star는 BrandMeister API의 기본적인 내장을 했고, 여러분의 리피터 또는 핫스팟에 관한 정보를 BrandMeister 네트워크

에서 읽어올 수 있게 되었습니다.   그러나 이 모든 정보는 일기-전용으로만 가능합니다.

현재까지 그것은...

1단계 - BrandMeister API 키 얻기 : https://brandmeister.network/의 BrandMeister 대시보드에 로그인합니다.

오른쪽 상단의 여러분 호출부호를 클릭합니다.

"Profile Settings" 옵션을 클릭합니다.

새로운 페이지에서 "API Keys"를 클릭합니다.

이제  API Keys 페이지에서 오른편에 있는 "Add" 버튼을 클릭합니다.

이 키에 대하여 이름을 지정하라는 프롬프트가 나오는데, 이 예제에서는 "Pi-Star"로 부르기로 합니다.

이제 여러분의 API 키가 나타나는데, 위쪽에 있는 텍스트 영역 내의 모든 텍스트를 선택하여, 다음 단계의 Pi-Star 대시보드에

사용하기 위해 복사 (마우스 오는쪽 키 클릭후 복사) 합니다.

텍스트를 복사했으면, OK 버튼을 누릅니다.

Step 2 - 여러분의 key를 Pi-Star에 추가하기

Pi-Star 대시보드를 찾아, Configuration 페이지에서 "Expert"를 찾아가면, Full Editors 부분에 있는 "BM API Key" 링크를

발견할 수 있을 것입니다.   여러분의 핫스팟이 http://pi-star.local/ 로 액세스 가능하다고 가정하면, 다음 링크는 여러분을

바로 그곳으로 연결시켜줍니다...http://pi-star.local/admin/expert/fulledit_bmapikey.php

여기에 1단계에서 얻은 API key를 입력합니다.

박스 안에 키를 붙여넣기 하고, apply changes를 누릅니다.

다 되었습니다.   다음번 여러분이 Pi-Star에서 "Admin" 링크를 사용하면 아래 그림과 같이 API 기능을 액세스할 수 있습니다.

안드로이드 앱 BrandMeister Tool 에서는 API Key 를 생성한후 앱내의 "DEVICE ADMIN" 탭에서 QR 코드를 스캔해 입력하고

사용하면 됩니다.

Repeater Reader 프로그램에서는 아직 해보지 않았습니다.   여러분의 테스트 결과를 기다립니다.

이상과 같이 소개를 드립니다.

이렇게 사용자 API key를 사용하면 BrandMeister Dashboard 에 웹브라우저를 사용해 로그인하고, 설정을 바꾸는 등 제어하는 

과정을 좀더 간단히, 편리하게, 스마트폰 등에서 할 수 있습니다.

DV4mini 사용자는 DMR SelfCare XTG (Extended Routing) 기능을 쉽게 사용할 수 있고,

리피터 관리자나 duplex hotspot 사용자는 Static Talk Group을 바꾸어 가며 쉽게 설정할 수 있는 등의 편리함을 누릴 수 있습니다.

여러분의 테스트 결과 공유를 기대합니다.  

[HL5KY]

BM서버를 일일이 열어보지 않아도 모든 현황을 한 눈에 보고 설정도 변경할 수 있게 되었네요. 아주 편리하겠습니다. 안내 감사합니다.

[DS5QDR]

몇일 전 위와같이 설정하였는데 정말 편리합니다
정보 설명 감사드립니다