출처

업데이트 됨

소스는 서비스의 데이터 소스를 나타냅니다. 예를 들어, iCloud 계정은 iCloud 서비스의 소스입니다.

소스에는 개별적으로 타겟팅 할 수있는 여러 rirelay.source 소스가있는 rirelay.instance 소스와 같은 하위 소스가있을 수 있습니다.

속성

이름 유형 기술
id 출처 ID 자원 식별자.
resource 문자열, 항상 source 자원 유형 지정자.
user 사용자 ID 이 소스에 연결된 사용자입니다.
type 이 소스의 유형 (예 : icloud.account 입니다.
identifier 서비스 범위 내에서 소스의 고유 식별자입니다.
parent 선택적, 출처 ID 소스가 다른 소스의 하위 항목 인 경우 채워집니다.
children 소스 리소스를 포함하는 목록 객체 소스하위 소스 를 포함합니다.
state 다음 중 하나 : unvalidated , active , deactivated , blocked , locked .
date_created 날짜 시간 리소스가 생성 된 시점.

종류

현재 지원되는 유형은 다음과 같습니다.

  • icloud.account , iCloud 서비스의 기본 소스.
  • rirelay.instance rirelay 서비스의 기본 소스입니다. Reincubate Relay 응용 프로그램의 인스턴스에 해당합니다.
  • rirelay.source 의 하위 소스 인 rirelay.instance 상위 Reincubate Relay 앱이 액세스 할 수있는 장치에 해당합니다.

식별자

소스의 identifier 속성 값은 해당 서비스 내에서 고유하게 식별됩니다. iCloud 계정의 경우 이는 사용자 이름입니다. Reincubate Relay 앱 인스턴스의 경우 인스턴스 ID가됩니다.

부모의

소스가 자식 소스 인 경우이 필드는 부모 소스 객체를 가리 킵니다. 이 계층 구조의 최상위 소스를 1 차 소스라고합니다.

하위 소스는 API를 통해 직접 작성할 수 없지만 적절한 폴이 작성되면 API에 의해 자동으로 작성됩니다.

상태

unvalidated
세션이이 소스에 대해 성공적으로 생성 된 적이 없으므로 API가 유효한 소스인지 여부를 알 수 없습니다.
active
소스가 유효하고 사용 준비가되었습니다.
deactivated
소스에 대한 액세스가 소유 조직에 의해 금지되었습니다.
blocked
소스에 대한 액세스가 API 관리자에 의해 금지되었습니다.
locked
소스에 대한 액세스가 외부 서비스에 의해 일시적으로 제한되었습니다.

가져 GET /sources/{source ID}

cURL 사용

curl https://ricloud-api.reincubate.com/sources/<source ID> \
  -H 'Authorization: Token <your key_token>'

ricloud-py 사용하기

import ricloud

source = ricloud.Source.create(<source ID>)

샘플 응답

{
  "id": 1,
  "resource": "source",
  "user": 1,
  "type": "mocks.mock",
  "identifier": "john.appleseed@reincubate.com",
  "info": null,
  "parent": null,
  "children": {
      "data": [],
      "has_more": false,
      "total_count": 0,
      "url": "/sources/1/children"
  },
  "state": "active",
  "date_created": "2020-02-20T11:59:03.195527Z"
}

GET /sources 나열

이름 유형 기술
organisation 슈퍼, 조직 ID 조직별로 필터링 할 API 관리자의 경우.
user 사용자 ID 연관된 사용자별로 필터링하십시오.
type 소스 유형별로 필터링하십시오.
identifier 소스 식별자별로 필터링하십시오.
state 원본 상태별로 필터링하십시오.
date_created 날짜 시간 필터 자원 생성 날짜별로 필터링하십시오.

cURL 사용

curl https://ricloud-api.reincubate.com/sources \
  -H 'Authorization: Token <your key_token>'

ricloud-py 사용하기

import ricloud

sources = ricloud.Source.list()

POST /sources/{source ID} 업데이트

이름 유형 기술
state 소스 상태를 업데이트하십시오.

cURL 사용

curl https://ricloud-api.reincubate.com/sources/<source ID> \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "state": "deactivated"
}'

ricloud-py 사용하기

import ricloud

source = ricloud.Source.update_with_id(<source ID>, state='deactivated')

# OR

source = ricloud.Source.retrieve(<source ID>)

source.update(state='deactivated')

변경 로그

2020-02-20

  • 전공의 children 소스 객체의 속성은 오히려 단순 목록 속성보다, 지금 중첩 된 목록 객체입니다.

2019-10-16

  • rirelay.instancerirelay.source 두 가지 새로운 소스 유형을 추가합니다.

어떻게 도와 드릴까요?

지원 팀이 도와 드리겠습니다!

근무 시간은 월요일부터 금요일, 오전 9 시부 터 오후 5시 (그리니치 표준시)입니다. 시간은 현재 11:31 오후 GMT입니다.

우리는 1 일 이내에 모든 메시지에 답장하고자합니다.

우리의 멋진 지원 팀

© 2008 - 2024 Reincubate Ltd. 판권 소유. 영국과 웨일즈에 등록 #5189175, VAT GB151788978. Reincubate® 및 Camo®는 등록 상표입니다. 개인 정보 정책 & 자귀.