소개

SORACOM CLI가 API Sandbox를 지원했기 때문에,
아래를 참조하여 CLI를 설치하고 Sandbox 환경을 사용해보십시오.

soracom-cli README_en.md - GitHub
SORACOM API Sandbox 사용 가이드 - 공식

환경

macOS High Sierra (10.13.6)

목차

SORACOM CLI 설치

SORACOM 콘솔에서 준비

soracom-cli API Sandbox 설정

soracom-cli API Sandbox 이동

덤

SORACOM CLI 설치

설치

설치 방법

$ brew tap soracom/soracom-cli
$ brew install soracom-cli
$ brew install bash-completion

이것뿐입니다! 간단하네요!

인수 보완

매우 편리하기 때문에 활성화합시다.

초기 상태에서는 홈 디렉토리에 .bashrc 파일이 없다고 생각하기 때문에 작성합니다.
다음 명령은 파일이 있으면 추가됩니다.

$ cat << EOT >> ~/.bashrc
eval "\$(soracom completion)"

EOT

그런 다음 .bash_profile 에 다음을 추가합니다.

if [ -f $(brew --prefix)/etc/bash_completion ]; then
  . $(brew --prefix)/etc/bash_completion
fi

if [ -f ~/.bashrc ]; then
    . ~/.bashrc
fi

SORACOM 콘솔에서 준비

전제 조건

프로덕션 환경에 계정이 있음

주의점

공식 페이지에도 기재가 있습니다만 주의점이 있습니다.

Sandbox는 일부 프로덕션 환경과 다르게 작동 할 수 있습니다

Sandbox 데이터는 지속되지 않습니다. (SORACOM 측이 삭제 될 수 있음)

유지 보수 등으로 사용할 수 없게 될 수 있음

프로덕션 환경에서 SAM 사용자 만들기

사용자 만들기

【사용자 만들기】 버튼을 눌러 다음 정보를 입력하여 작성합시다.




품목
입력값
비고


이름
SORACOM_API_Sandbox_User

개요
SORACOM API Sandbox 이용 사용자 (롤 없음, 로그인 없음, 인증 키 있음)
선택적

인증 키 생성

권한 설정, 로그인 암호 설정은 필요하지 않습니다.
작성한 사용자의 인증 키만 생성합시다.

【인증 키 생성】 버튼을 누릅니다.


認証キーID


이것으로 콘솔 화면의 작업이 종료됩니다.

soracom-cli API Sandbox 설정

API Sandbox용 프로필 생성

다음 명령을 실행하여 대화형으로 프로파일을 작성하십시오.

$ soracom configure-sandbox
--- SORACOM CLI セットアップ (Sandbox) ---
/Users/{username}/.soracom ディレクトリがなければ作成し、そこにファイル 'sandbox.json' を作成します。

カバレッジタイプを選択してください。

1. Global
2. Japan

選択してください (1-2) > 2  → (任意)


本番環境の AuthKeyID と AuthKey のペアを入力してください。これらは本番環境のアカウントを持っているかどうかを確認するためだけに使われます。

authKeyId: xxxxx
authKey: xxxxx


Sandbox 環境に作成するオペレーターのメールアドレスとパスワードを入力してください。

email: [email protected]  → ※1
password:                         → ※2

プロファイル sandbox はすでに存在しています。上書きしますか？ (Y/n)   → ※3

한번 사용한 이메일 주소는 사용할 수 없으므로 자신의 이메일 주소 등을 사용하여 독특하게 되도록 합시다.

암호 정책을 충족해야 합니다.

이미 sandbox.json이있는 경우 출력됩니다. 필요한 경우 사전에 이름을 바꾸어 퇴피해 둡시다. n을 선택하면 Error: abort가 됩니다.

여기까지 오퍼레이터 작성까지 행해집니다.

soracom-cli API Sandbox 이동

API Sandbox를 사용하는 경우 반드시 認証キーシークレット를 지정해야 합니다.

운영자 정보 얻기

$ soracom operator get --profile sandbox
{
    "attributes": null,
    "createDate": "2018-12-31T00:00:00.000",
    "description": null,
    "email": "[email protected]",
    "operatorId": "OP00xxxxxx40",
    "updateDate": "2018-12-31T00:00:00.000"
}

덤

인수 보완이 있다고 생각합니다!

탭 키를 누를 때 보완

$ soracom 
auth                lagoon              query
bills               logs                roles
completion          lora-devices        sandbox
configure           lora-gateways       shipping-addresses
configure-sandbox   lora-network-sets   sigfox-devices
coupons             operator            stats
credentials         orders              subscribers
data                payer-information   unconfigure
devices             payment-history     users
event-handlers      payment-methods     version
files               payment-statements  vpg
groups              products
$ soracom 

요약

Sandbox를 이용하는 것으로 돈을 들이지 않고 여러가지 동작을 안심하고 시험할 수 있군요!