All applications submitted to the Onshape App Store (Onshape Apps) must follow the instructions on the API Guide: OAuth2 page and use OAuth2 for authorization. Automation scripts (or applications not meant for the Onshape App Store) may use either OAuth2 or API Keys for authentication. OAuth2 allows applications to call Onshape APIs on behalf of the users of the application; API keys will only perform operations on behalf of the Onshape user who generated the API keys.

Onshape アプリケーションの操作について詳しくは、Onshape API 開発者向けドキュメントを参照してください。

To navigate to your Developer settings in Onshape, click on your Account user icon (アカウントユーザーアイコン) in the top right corner of your Onshape window. This opens a dropdown menu. Click My account.

ページの左側のリストで [開発者] をクリックします。

My Account: Developer

API keys are a useful way create small applications meant for personal use, allowing developers to avoid the overhead of the OAuth workflow.

API keys are used to authenticate an application, not its users. (OAuth2 authenticates an application and users of the application by ensuring the users are authorized to access Onshape.)

Once you create an API key, it is valid only in the stack on which it was created. An API key created on your company stack (i.e., companyName.onshape.com) will not function on the production stack (cad.onshape.com). Administrators can also manage API keys for users in their company: see Company/Classroom/Enterprise settings - Developer.

API キーの表示

  1. Click API keys on the Developer page.
  2. View all your previously-created API keys.
    開発者画面にリストされる API キー

API キーの作成

  1. [新しい API キーを作成] をクリックします。
    [新しい API キーを作成] 画面
  2. [名前] フィールドに API キーの名前を入力します。
  3. キーのアクセス許可を選択します。以下のアクセス許可の範囲を参照してください。
  4. [API キーを作成] ボタンをクリックします。

  5. ポップアップウィンドウで、表示される API キーとシークレットキーをコピーしてどこかに保存し、[閉じる] ボタンをクリックします。

    シークレットキーは二度と表示されないので、安全な場所に保管してください。

    ユーザーに表示されるシークレットキー

API キーの削除

  1. 削除したい API キーの右にある「X」アイコンをクリックします。
  2. Confirm that you want to delete this API key. This action cannot be undone. Click Delete to confirm.
    API キーを削除

OAuth アプリケーションの作成時には、次のアクセス許可の範囲を使用できます。

  • アプリケーションではプロファイル情報を読み取ることができます (OAuth2ReadPII) - これをオンにすると、アプリケーションにプロファイル上の情報へのアクセスを許可します。

  • アプリケーションではドキュメントを読み取ることができます(OAuth2Read) - これをオンにすると、アプリケーションにドキュメントからの読み取りを許可します。

  • アプリケーションではドキュメントに書き込むことができます (OAuth2Write) - これをオンにすると、アプリケーションにドキュメントへの書き込みを許可します。

  • アプリケーションではドキュメントおよびワークスペースを削除できます (OAuth2Delete) - これをオンにすると、アプリケーションにドキュメントとワークスペースの削除を許可します。

  • アプリケーションではあなたの代わりに購入をリクエストできます (OAuth2Purchase) - これをオンにすると、アプリケーションに購入を許可します。

  • アプリケーションではドキュメントを共有および共有解除できます (OAuth2Share) - これをオンにすると、アプリケーションにドキュメントの共有と共有解除を許可します。