프로토콜
비동기 처리
API는 모든 폴에 대해 비동기 처리를 사용합니다. 여기에는 iCloud와 같은 외부 서비스와의 상호 작용이 포함됩니다. 필요한 처리량에 따라 완료하는 데 몇 초 또는 몇 분이 걸릴 수 있기 때문입니다.
여러 표준 자원 상호 작용이 비동기 '부작용'을 유발할 수 있으며 API 참조 문서에 설명되어 있습니다. 일반적으로 유효성 검사 또는 기타 유틸리티 기능을 수행합니다.
API의 비동기 적 기반은 API 내에서 트리거되는 주기적 폴링에 대한 인터페이스를 단순화하는 데에도 도움이됩니다. 즉, 이벤트 및 결과 검색은 API와 직접 상호 작용하거나 예정된 설문 조사를 통해 이루어지는 것과 동일합니다.
응답을 기다리고있다.
API는 폴링 필요성을 최소화하고 최종 사용자의 총 응답 시간을 줄이기 위해 오래 지속되는 요청을 통해 비동기 작업 완료를 기다리는 것을 지원합니다. 이 기능을 사용하려면 원하는 시간 초과 값을 사용하여 Ricloud-Await
HTTP 헤더를 요청에 추가하십시오. 현재 최대 시간 초과 값은 10 초입니다.
Ricloud-Await: 3
이 기능은 다음 엔드 포인트에서 지원됩니다.
- 세션
POST /sessions
생성 - 저장소 구성
POST /configs/storage/{storage_config ID}/test
-
POST /configs/webhook/{webhook_config ID}/test
설정POST /configs/webhook/{webhook_config ID}/test
암호화 된 게시
API에서 게시 한 모든 결과는 조직 전체의 공용 RSA 키를 사용하여 암호화 할 수 있습니다.
최종 사용자 시험
최종 사용자 평가판 모듈은 클라이언트가 사용할 수 있습니다. 이는 잠재적 인 최종 사용자에게 데이터의 "티저"를 반환하는 데 사용할 수 있습니다. 이 모듈은 마지막 5 개의 메시지와 마지막 위치 및 사용 가능한 다른 메시지의 요약 수를 제공합니다.
이 메커니즘을 사용하면 최종 사용자 평가판에 전체 키를 사용하는 것보다 비용 효율적일 수 있습니다.
분석 및보고
ricloud의 iCloud 서비스는 분석 및보고와 관련된 여러 가지 추가 기능을 제공합니다.
하루 동안 iOS 기기에서 사용 된 앱을 보여주는 기본 앱 사용과 세션 수, 세션 시간 등 더 많은 정보를 제공하는 고급 앱 사용 등 두 가지 모듈을 기업에서 사용할 수 있습니다. 이 모듈에 대한 자세한 내용은 요청시 제공됩니다.
법의학 및 복구
메시지 (SMS, MMS 및 iMessage) 및 iCloud 사진 라이브러리 모듈을 포함하여 아래에 표시된 여러 모듈에 대해 법 의학적 삭제 및 복구 기능을 사용할 수 있습니다.
Reincubate에는 WhatsApp 및 WeChat을 비롯한 다른 모듈에 대한 요청에 따라 적용 할 수있는 여러 가지 맞춤 포렌식 도구가 있습니다.
속성 유형
날짜 시간
날짜 / 시간 속성은 ISO8601 사양에 따라 형식이 지정됩니다. API는 UTC 시간대가 포함 된 모든 날짜 / 시간 속성 (예 : "2018-08-22T10:25:05Z"
합니다.
여러 자원 목록 엔드 포인트를 사용하면 date_created
와 같은 날짜 시간 속성을 필터링 할 수 있습니다. 보다 유용한 연산자를 사용하여 필터링하려면 날짜 시간 필터 값 앞에 lt_
, lte_
, gt_
또는 gte_
중 하나를 lt_
gte_
.
타임 델타
timedelta 유형의 속성은 달리 지정되지 않는 한 항상 초 단위입니다.
쪽수 매기기
API는 커서 기반 페이지 매김을 사용합니다. 모든 목록 유형 호출은 추가 매개 변수를 사용합니다.
-
limit
반환 할 최대 항목 수를 지정합니다. 기본값은 10이며, 최대 값은 1000입니다. -
after_id
목록을 시작할 ID를 지정합니다. -
before_id
목록을 중지 할 자원 ID를 지정합니다.
리스트 응답은 data
속성 아래에 리턴 된 자원을 포함합니다. 또한 제한으로 인해 포함되지 않은 더 많은 자원을 나열 할 수 있는지 여부를 나타내는 helper 속성 has_more
도 포함됩니다.
속도 제한
API에 대한 요청은 표준 속도 제한이나 기내 요청 제한에 의해 제한 될 수 있습니다. 전자는 대규모 API 리소스의 남용을 최소화하는 데 사용되는 반면, 후자는 개별 리소스 인스턴스를 보호하는 데 사용됩니다.
요율 제한의 예 : 단일 조직에서 API에 대한 요청 수는 시간당 10,000 요청으로 제한됩니다. 이는 트래픽의 악의적 인 또는 우발적 인 스파이크로부터 보호하는 데 도움이됩니다.
기내 제한 예제 : 다른 작업이 이미 처리중인 경우 원본 리소스의 인스턴스에 대해 생성 된 작업을 가질 수 없습니다. 이는 세션 무결성을 유지하고 외부 서비스로의 트래픽을 최소화하며
버전 관리
API의 주요 릴리스가 크게 의미있는 버전 관리 체계 (예 : v1 , v2 , v3 )를 따르지 만 v3 버전의 API에서 변경된 사항은 달력 버전 관리 체계 (예 : 2018-11-06 )에 따라 버전이 지정됩니다. 이 버전은 조직에 대해 전 세계적으로 설정하거나 Ricloud-Version
헤더를 통해 요청별로 지정할 수 있습니다.
삭제 가능한 리소스
대부분의 리소스는 삭제할 수 없으므로 소유 조직에서만 비활성화하거나 API 관리자가 차단할 수 있습니다.