개요

Reincubate의 ricloud API에 대한 설명서입니다. API는 Reincubate Relay 앱을 통해 사용자가 Apple의 iCloud 및 로컬 iTunes 백업에서 자신의 데이터에 액세스 할 수 있도록합니다.

제품 정보는 ricloud API 제품 페이지를 참조하십시오 .

주요 개념

자원

API는 일련의 리소스로 구성됩니다. 클라이언트는 CRUD (Create, Retrieve, Update and Destruct)를 작성하여 API에서 조작을 구성, 트리거 및 모니터 할 수 있습니다. 자세한 내용은 API 리소스 참조 를 참조하십시오.

비동기 처리

API는 타사 서비스 및 데이터 처리에 대비하여 세션을 설정하기위한 비동기 작업에 의존합니다. 이를 통해 대용량의 데이터 요구 사항을 관리하고 책임감있게 외부 서비스와 상호 작용할 수 있습니다. 또한 응답 시간의 변동 또는 제 3 자의 서비스 저하에 대응할 수있는 유연성을 제공합니다.

스토리지 버킷 게시

API에서 요청한 데이터는 Google Cloud Storage 또는 Amazon S3의 클라이언트 양동이에 직접 게시됩니다. 이렇게하면 데이터 전달 확장과 관련된 문제를 최소화하는 데 도움이되며 게시가 병목 현상이 될 가능성이 적어 빠른 데이터 검색이 가능합니다.

Webhook 알림

비동기 작업 완료 알림은 웹 후크를 통해 처리되므로 표준 HTTP 요청을 통해 이벤트가 클라이언트의 서버로 전송됩니다. 이러한 이벤트에는 클라이언트 버킷 내에서 요청 된 데이터를 찾을 수있는 위치에 대한 정보가 포함되어있어 클라이언트가 언제, 어떻게 사용하는지 결정할 수 있습니다.

핵심 용어

시작하기 섹션으로 넘어 가기 전에 전체적으로 사용되는 몇 가지 용어와 개념에 익숙해지면 도움이됩니다.

서비스

서비스는 API를 통해 사용할 수있는 데이터 소스 모음을 설명합니다. 이것은 asrelay 등 아이 클라우드와 같은 타사 서비스, 또는 Reincubate 제품을 포함한다.

다양한 서비스는 API의 특정 리소스에 대한 다양한 요구 사항을 가지며 API 개체의 전체 수명주기를 변경합니다. 예를 들어, iCloud 서비스에 대한 세션을 생성하는 데 필요한 페이로드는 asrelay 서비스에 필요한 세션과 다릅니다.

출처

서비스 내 특정 데이터 소스입니다. iCloud 계정은 iCloud 서비스의 기본 소스 인 반면 Reincubate Relay 앱 인스턴스는 Reincubate Relay 서비스의 기본 소스입니다.

사용자

사용자는 데이터를 요청하는 최종 사용자를 나타냅니다. 대부분의 경우 이것은 응용 프로그램의 사용자입니다.

세션

세션은 특정 소스에 대한 액세스를 나타내며 API를 통해 소스에서 정보 또는 데이터를 검색하기 위해 필요합니다.

세션 생성은 iCloud 계정에 '로그인'하거나 Reincubate Relay 앱 인스턴스와 '페어링'하는 것과 같습니다.

API는 세션 초기화 프로세스를 비동기 적으로 실행합니다. 즉, 세션 생성 호출은 즉시 반환되지만 초기화가 완료 될 때까지 세션을 사용할 수 없습니다.

투표

설문 조사는 사용자가 API를 통해 데이터를 요청할 수있는 방법입니다. 설문 조사를 작성하려면 대상 소스에 대한 활성 세션이 필요합니다.

모든 폴은 하나 이상의 작업을 통해 비동기 적으로 처리되며 결과는 조직에 구성된 클라우드 저장소 버킷에 게시됩니다.

태스크

이것들은 API가 수행하는 기본 작업 덩어리입니다. 세션이 작성되면 외부 서비스에 대해 초기화를 수행하기위한 태스크도 작성됩니다. 설문 조사가 작성되면 필요한 작업을 수행하기위한 하나 이상의 태스크가 작성됩니다.

결과

결과는 클라이언트의 스토리지 버킷에 게시 된 데이터 또는 파일에 대한 참조입니다.