ricloud-py 클라이언트 구현
ricloud-py 클라이언트는 ricloud v3 API 인터페이스를 직접 구현 한 것입니다. 또한 일반적인 사용 사례에 대한 몇 가지 샘플 구현과 타사 스토리지 버킷 (AWS S3 및 Google Cloud Storage)에서 데이터를 가져 오는 몇 가지 기본 구현을 포함합니다.
설치
클라이언트를 얻는 가장 간단한 방법은 PyPi 에서 클라이언트를 설치하는 것 입니다 .
pip install ricloud==3.0.0
GitHub 저장소 에서 코드를 가져올 수도 있습니다.
구성
key_token 은 API에 대해 인증해야합니다. 기존 고객 인 경우 엔터프라이즈 지원 에 문의하여 ricloud v3 API의 평가판 키를 받으십시오 .
ricloud-py 는 두 가지 방법으로 구성 할 수 있습니다.
- 가져온
ricloud모듈의token속성을 통해.
import ricloud ricloud.token = '<your key_token>'
- 다음 내용으로 홈 디렉토리에
.ricloud.ini파일을 만듭니다.
[api] token = <you key_token>
자세한 내용은 .ricloud.ini 파일 참조 를 참조하십시오.
용법
클라이언트는 각 API 리소스에 대한 클래스와이 클래스와 상호 작용할 메서드 집합을 제공합니다.
>>> import ricloud >>> org = ricloud.Organisation.retrieve() >>> print(org.name) My Organisation >>> org.update(name='Changed Organisation') >>> print(org.name) Changed Organisation
샘플 구현
클라이언트는 다수의 공통 상호 작용에 대한 샘플 구현을 포함합니다.
samples 명령을 통해 액세스 할 수 있습니다.
iCloud
iCloud 샘플 구현을 사용하면 명령 줄을 통해 iCloud 계정에서 데이터를 빠르게 검색 할 수 있습니다.
재인 큐 베이트 릴레이
Reincubate Relay 서비스 샘플은 세션 생성, 구독 설정 및 수동으로 폴링 트리거에 필요한 일련의 명령을 구현합니다.
웹 후크 엔드 포인트
클라이언트는 들어오는 API 이벤트 알림을 수신하고 콘솔에 정보를 인쇄하는 간단한 웹 후크 엔드 포인트 구현을 포함합니다.
로컬 엔드 포인트를 인터넷에 안전하게 노출 시키려면 ngrok 와 같은 유틸리티를 사용하는 것이 좋습니다. 기본적으로 웹 후크 엔드 포인트는 컴퓨터의 포트 8080에 바인딩됩니다.
ngrok http -bind-tls=true 8080
https://abcd1234.ngrok.io 와 같이 Forwarding 행에서 공개적으로 노출 된 ngrok 엔드 포인트의 주소를 볼 수 있습니다.
그런 다음 ricloud event listen 명령을 실행하여 리스너를 시작할 수 있습니다. 클라이언트가 올바르게 구성된 경우 명령에 지정된 URL을 사용하여 웹 후크 구성을 자동으로 작성하고 현재 사용중인 키의 기본 웹 후크 구성으로 설정합니다.
ricloud event listen --webhook-url https://abcd1234.ngrok.io
.ricloud.ini 파일 참조
섹션 : api
token
API의 엔드 포인트에 대해 인증하는 데 사용되는 토큰.
url
API의 기본 URL입니다. 기본값 : https://ricloud-api.reincubate.com .
max_retries
요청이 서버 또는 연결 오류로 인해 실패한 경우 요청을 다시 시도 할 횟수입니다. 기본값 : 3
await_for
지정된 값으로 Ricloud-Await 헤더를 추가하여 await 응답 메커니즘을 활성화합니다. 기본값 : 0
섹션 : webhooks
secret
수신 이벤트 알림 페이로드를 확인할 때 사용할 웹 후크 구성 비밀번호입니다. ricloud event listen 명령에 --webhook-url 옵션을 사용하면 자동으로 설정됩니다.
delta
이벤트가 전송 된 시간과 수신 된 시간 사이에 허용되는 차이 (초)입니다. 기본값 : 600
섹션 : logging
log_level
섹션 : samples
output_directory
샘플 스크립트의 일부로 다운로드 한 결과의 기본 출력 디렉토리. 디렉토리 경로가 상대 경로이면 현재 작업 디렉토리를 기준으로 생성됩니다.
user_identifier
클라이언트는 샘플 스크립트를 실행할 때 User 자원을 작성합니다. 이 사용자의 식별자의 기본값은 ricloud-py 이지만이 옵션을 통해 쉽게 사용자 정의 할 수 있습니다.
이는 예를 들어 같은 조직 내의 여러 개발자 사이의 사용을 구별하는 데 유용 할 수 있습니다.
[api] token = <your key_token> url = https://ricloud-api.reincubate.com max_retries = 1 [logging] log_directory = logs log_level = WARNING [samples] output_directory = output user_identifier = ricloud-py
