다음 용도로만 사용 가능

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.

페이지 왼쪽의 목록에서 개발자를 클릭합니다.

엔터프라이즈 설정: 개발자

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) -  애플리케이션이 사용자의 통합문서를 공유하고 공유 취소할 수 있는 권한을 허용하려면 체크합니다.