르면가게 2024. 12. 25. 11:44

Authentication — python-api v3.7.0 문서

ShotGrid Python API 인증 가이드는 서버와 API를 통신하기 위해 필요한 인증 정보를 제공합니다. 주요 내용을 요약하면 다음과 같습니다:

인증 방식

사용자 기반 인증:

  • 일반적인 로그인과 비밀번호를 사용하여 인증합니다.
  • 이 방법으로 생성된 API 객체의 작업은 사용자 권한 수준에 따라 제한됩니다.
sg = shotgun_api3.Shotgun(
    "<https://my-site.shotgrid.autodesk.com>",
    login="사용자이름",
    password="비밀번호"
)

스크립트 기반 인증:

  • Flow Production Tracking에 등록된 스크립트와 유효한 API 키를 사용하여 인증합니다.
  • 스크립트 이름과 API 키를 제공해야 합니다.
sg = shotgun_api3.Shotgun(
    "<https://my-site.shotgrid.autodesk.com>",
    script_name="스크립트 이름",
    api_key="API 키"
)
  • 스크립트별로 별도 API 키를 생성하는 것이 권장되며, 이를 통해 각 스크립트의 작업을 정확히 추적할 수 있습니다.

스크립트 사용자 추가

  • Admin 섹션의 “Scripts” 페이지에서 새로운 Script 엔터티를 생성하고 이름을 부여합니다.
  • 저장하면 자동으로 스크립트 비밀번호 역할을 하는 애플리케이션 키가 생성됩니다.
  • 각 스크립트에 고유한 애플리케이션 키를 사용하는 이유는 문제 발생 시 추적 및 관리가 용이하기 때문입니다.

이벤트 로깅

  • 스크립트 작업은 기본적으로 이벤트 로그에 기록됩니다.
  • 필요 시 Admin 페이지에서 이벤트 로깅을 비활성화할 수 있습니다.
  • 이메일 알림은 이벤트 로그에 기반하므로, 로그를 끄면 알림도 작동하지 않습니다.

권한

  • 사용자의 권한 및 스크립트의 역할은 Flow Production Tracking의 권한 규칙에 따라 제한됩니다.
  • 스크립트 기본 권한은 “API Admin User”로, 엔터티 생성, 수정, 삭제에 대한 전체 접근 권한을 가집니다.
  • 사용자 기반 인증의 경우, 사용자가 가진 권한에 따라 스크립트 작업이 제한됩니다.

https://developers.shotgridsoftware.com/python-api/authentication.html

 

Authentication — python-api v3.7.0 documentation

By default, events generated by scripts using an script-based authentication are logged in Flow Production Tracking’s event log. You can turn this off by un-checking the “Generate Events” checkbox either in the script detail page or from the main Scr

developers.shotgridsoftware.com