のみ利用可能

Allow Enterprise admins to create new applications to which enterprise users can subscribe. Admins can manage and distribute these applications to specified users. Admins can also create, view, and delete API keys for users in their company or enterprise.

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 Company/Classroom/Enterprise settings.

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

Enterprise 設定: 開発者

What admins can do from this screen

  • Create an internal application in the company settings without going to the App Store dev portal.

  • Manage the application internally.

  • View, create, and delete API keys for anyone in the company.

  1. [OAuth アプリケーション] リンクをクリックします。

    新しい OAuth アプリケーションを作成

  2. [新しい OAuth アプリケーションを作成] ボタンをクリックします。

    OAuth アプリケーションを作成

  3. 以下のように情報を入力します (詳細情報は画面上にも表示されます)。

    • 名前 - ユーザーに表示されるアプリケーション名前。

    • プライマリ形式 - アプリケーション識別するための一意の文字列。ユーザーには表示されません。

    • 概要 - アプリケーションに関する情報。

    • リダイレクト URL - 認証後にリダイレクトされる URL。

    • タイプ - アプリケーションのタイプ。オプションは、[統合クラウドアプリ]、[接続されたクラウドアプリ]、または [接続されたデスクトップアプリ] です。

    • OAuth URL - Onshape アプリケーションページから OAuth プロセスを開始するために使用される URL。

    • 設定

      • 共同作業をサポート - アプリケーションの開発時に、他のユーザーとの共同作業を行う場合はオンにします。

    • 権限 - 以下のアクセス許可の範囲を参照してください。

  4. [アプリケーションを作成] をクリックします。

  5. [メンバーを検索] フィールドを使用して、アプリケーション開発やテストに参加するユーザーを検索して選択します。

  6. アプリケーションへのアクセスを許可するアプリケーションの承認画面がユーザーに提供されます。

    アプリを承認

  7. OAuth によるアプリケーションの認証については、API ガイド: 認証を参照してください。

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.

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 companyName.onshape.com will not function on cad.onshape.com.

API keys that are not associated with a company or enterprise can be managed through the My Account - Developer page.

API キーの表示

  1. In your Company/Classroom/Enterprise Developer settings, click API keys
  2. Review the API keys available for the company.
    開発者画面にリストされる API キー

API キーの作成

  1. In your Company/Classroom/Enterprise Developer settings, click API keys
  2. [新しい API キーを作成] をクリックします。
    [新しい API キーを作成] 画面
  3. [名前] フィールドに API キーの名前を入力します。

  4. Assign the API key to someone in the company. You can search by name or email in the User field.

  5. キーのアクセス許可を選択します。以下のアクセス許可の範囲を参照してください。
  6. [API キーを作成] ボタンをクリックします。

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

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

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

  8. API キーを使用してアプリケーションを認証する方法については、API ガイド: 認証を参照してください。

API キーの削除

  1. 削除したい API キーの右にある「X」アイコンをクリックします。
  2. この API キーをすべてのユーザーに対して削除することを確認してください。このアクションは元に戻せません。[削除] をクリックして確定します。
    API キーを削除

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

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

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

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

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

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

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