figma rest api

figma REST apiについて

https://www.figma.com/developers/api
- REST APIなのかFigma APIなのか
  - Figma APIぽい
- Figma's mission is to make design accessible to everyone.
- Figma APIは読み取りとインタラクション？をサポートしている
- オブジェクトやレイヤーのプロパティーを抽出して、Figmaの外部で扱うことができる
- 認証
  - アクセストークン or OAuth2
    - パーソナルアクセストークンを生成するのがAccount Settingsからできる
      - X-Figma-Tokenをリクエストヘッダーに入れて使う
    - 推奨されているのはOAuth2
      - アプリケーションを登録する必要がある
- HTTPのエンドポイントを介してアクセス
  - files, images, file versions, users, comments, team projects, project files
- アクセス許可されると、ファイルをJSONで表現されたデータで見れる
  - GET or POSTでファイルやレイヤーへのコメントの取得、追加などもできる
- scopes
  - files:read
  - file_variables:read / file_variables:write
  - file_comments:write
  - file_dev_resources:read / file_dev_resources:write
  - webhooks:write
- files
  - ノードツリー
    - DOCUMENTがルート
    - CANVASがはえる。これはPAGEを示している？
    - CANVASには任意の子ノードがはえる
    - ノードにはグローバルなものとノード固有のものがある？
  - ノードの種別
    - DOCUMENT
    - CANVAS
    - FRAME
    - GROUP
    - SECTION
    - VECTOR
    - BOOLEAN_OPERATION
    - STAR
    - LINE
    - ELLIPSE
    - REGULAR_POLYGON
    - RECTANGLE
    - TABLE
    - TABLE_CELL
    - TEXT
    - SLICE
    - COMPONENT
    - COMPONENT_SET
    - INSTANCE
    - STICKY
    - SHAPE_WITH_TEXT
    - CONNECTOR
    - WASHI_TAPE
  - プロパティ
    - Color
    - ExportSetting
    - Constraint
    - Rectangle
    - ArcData
    - BlendMode
    - MaskType
    - EasingType
    - FlowStartingPoint
    - LayoutConstraint
    - LayoutGrid
    - Effect
    - Hyperlink
    - DocumentationLink
    - Paint
    - Vector
    - Size
    - Transform
    - ImageFilters
    - FrameOffset
    - ColorStop
    - PaintOverride
    - TypeStyle
    - Component
    - ComponentSet
    - Style
    - ShapeType
    - ConnectorEndpoint
    - ConnectorLineType
    - ConnectorTextBackground
    - ComponentPropertyDefinition
    - ComponentProperty
    - ComponentPropertyType
    - InstanceSwapPreferredValue
    - PrototypeDevice
    - StrokeWeights
    - Overrides
    - VariableAlias
- comments
- users
- version history
- projects
- component and styles
  - file styles
    - GET/v1/files/:file_key/styles
    - https://forum.figma.com/t/get-file-styles-why-there-are-no-values-properties/19900
      - stylesの情報が欲しくても、これでは得られる感じがしない？

makotot/figma-rest-api.md

figma REST apiについて