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