검토 링크 작업

개요

검토 링크는 에셋을 수집하고 명시적인 팀이나 프로젝트 액세스 없이도 단일 URL을 통해 피드백을 주고받기 위해 이를 전송하는 Frame.io의 핵심 기능입니다. 기본적으로 검토 링크는 단일 프로젝트 내에 있는 에셋의 표현이므로, 이 가이드에서는 다음 사항을 가정합니다.

1. 이미 에셋을 가지고 있거나 API를 통해 에셋을 업로드하는 것에 익숙해야 합니다.
2. 검토 링크를 생성하려는 프로젝트의 ID를 알고 있어야 합니다.
3. 여러분의 최종 목표는 Frame.io 외부(예: 이메일, 채팅, 또는 기타 메시지 발송)에 배포할 수 있는 URL을 얻는 것입니다.

핵심 개념

검토 링크는 전적으로 프로젝트에 속하며, 검토 링크 내의 에셋은 검토 링크 항목이라는 특수 리소스 유형으로 표시됩니다. 여기에는 조인되는 review_link_id 및 asset_id와 연결된 에셋의 전체 페이로드가 항상 포함됩니다.

검토 링크 항목을 자체적으로 추적하거나 관리할 필요는 없지만, 이 가이드에서 다루는 전체 워크플로를 이해하는 데 도움이 되는 유용한 구조입니다. 따라서 검토 링크의 계층 구조는 다음과 같습니다.

Project > Review Link > Review Link Item > Asset reference

필수 범위

이 가이드를 시작하기 전에 최소한 다음 범위가 포함된 토큰이 있는지 확인해야 합니다.

1.ID 수집

검토 링크를 생성하려면 다음 항목들을 수집해야 합니다.

1. 프로젝트 ID
2. 해당 프로젝트 내에 있는 하나 또는 여러 개의 에셋 ID

프로젝트 ID가 바로 없더라도 Frame.io에 액세스할 수 있고 사용할 프로젝트를 알고 있다면, 프로젝트로 이동할 때 주소 표시줄에서 ID를 확인할 수 있습니다. https://app.frame.io/projects/<project-id></project-id>.마찬가지로 에셋 ID를 바로 알 수 없는 경우 원하는 에셋으로 이동하여 브라우저의 주소 표시줄에서 ID를 가져올 수 있습니다. https://app.frame.io/player/<asset-id></asset-id>.

2.검토 링크 생성

링크의 기반을 생성하려면, 원하는 검토 링크 옵션을 결정하고 이를 JSON 페이로드로 구성해야 합니다. 최소한 name을 지정해야 합니다. 다음은 페이로드의 예시입니다. 편의를 위해 name만 지정하여 생성할 경우 각 필드의 기본값이 표시됩니다.

1
{    
2
    "name": "New Review Link",
3
    "allow_approvals": true,
4
    "current_version_only": false,
5
    "enable_downloading": true,
6
    "expires_at": null,
7
    "has_password": false
8
}

이제 페이로드를 요청 본문으로 사용하여 https://api.frame.io/v2/projects/:id/review_links로 인증된 POST 요청을 수행합니다.

축하합니다!방금 검토 링크를 성공적으로 생성하셨습니다. 응답 본문에서 두 가지 중요한 속성을 확인할 수 있습니다.

• id: 링크 컨테이너에 대한 참조입니다. 다음 단계에서 에셋을 추가할 때 필요하므로 잘 보관해 두세요.
• short_url: 최종적으로 배포하게 될 검토 링크의 URL입니다. https://f.io/_aBcDeF와 같은 형태가 됩니다.

3.검토 링크에 에셋 추가

이제 검토 링크가 준비되었으므로, 여기에 몇 가지 에셋을 추가할 차례입니다. 에셋 id의 문자열 배열이 포함된 JSON 페이로드를 준비하여 시작합니다.

1
{
2
    "asset_ids":[
3
        "<asset-id-1>",
4
        "<asset-id-2>",
5
        "<asset-id-3>"
6
    ]
7
}

이제 경로에 2단계의 검토 링크 id를 사용하고 요청 본문에 에셋 id를 사용하여 https://api.frame.io/v2/review_links/:id/assets로 인증된 POST 요청을 수행합니다. 모두 완료되었습니다! 이제 short_url을 배포할 준비가 되었습니다.