Skip to content

파트너에게 공개할 API 등록하기 (공통 순서) ​

이럴 때 씁니다 ​

파트너가 우리 데이터를 찾고 받으려면 공유 메뉴에서 해당 API를 등록해 카탈로그에 올려야 합니다. 5종의 등록 방법은 같습니다. 어떤 API가 필요한지는 하려는 일로 고릅니다.

하려는 일등록할 API없으면
파트너가 우리 제품(디지털 트윈)을 찾게 하기디지털 트윈 레지스트리 API제품은 만들어지지만 파트너가 찾지 못합니다
제품에 PCF 붙이기, 파트너와 PCF 주고받기PCF 교환 APIPCF 제품 생성이 시작되지 않고 안내가 뜹니다
고객에게 납품한 부품 식별 정보 보내기·받기디지털 트윈 이벤트 API보내기 버튼이 활성화되지 않습니다
품질 알림 주고받기품질 알림 API품질 알림을 받을 수 없습니다
부품 차단 주고받기품질 알림 API의 부품 차단 수신·부품 차단 갱신 채널(선택)부품 차단 요청·상태 업데이트를 받을 수 없습니다 → 부품 차단 주고받기
기업 인증서 알림 주고받기CCM 알림 API인증서 교환 알림을 받을 수 없습니다

시작하기 전에 ​

  • 조직 소유자 계정이어야 합니다. 멤버에게는 등록 버튼이 보이지 않습니다. → 소유자와 멤버
  • 공유 → 데이터스페이스의 연결 상태가 정상이어야 합니다.
  • 정책은 등록 자체에는 필요 없습니다. 등록하면 기본 정책이 함께 만들어지고, 파트너와 관계 추가를 하거나 제품을 공개할 때 정책이 필요합니다. → 첫 정책 만들기

따라 하기 ​

  1. 공유에서 등록할 API를 고릅니다(예: 디지털 트윈 레지스트리 API). 내 엔드포인트 카드 표에는 이 API가 만들 수 있는 채널마다 한 줄이 늘 있습니다(PCF·CCM·디지털 트윈 1줄, 품질 알림 6줄(부품 차단 2줄 포함), 디지털 트윈 이벤트 3줄). 아직 등록하지 않은 채널은 미등록 태그와 등록 버튼이 보입니다. 카드 제목 옆 태그는 등록된 채널 수/전체 채널 수입니다. 아래는 이미 등록을 마친 조직의 화면입니다(이전 화면 캡처 — 곧 교체).

공유 → 디지털 트윈 레지스트리 API (등록된 상태) 2. 채널 행의 등록을 누르면 엔드포인트 API 추가 창이 열립니다. 커넥터(EDC) 버전 행이 두 줄 보입니다. Saturn이 현재 버전(EDC 0.11 이상), Jupiter가 이전 버전(EDC 0.10 이하)입니다. 어느 버전도 자동으로 만들어지지 않으며, 등록할 버전을 직접 고릅니다.

엔드포인트 API 추가 창 3. 상대 기업 커넥터 버전에 맞는 행의 추가를 누릅니다. 상대 기업 버전은 파트너 관계 상세의 상대 기업 EDC 버전 카드(현재 버전 · 이전 버전 가능성 · 미확인)로 확인합니다 — 새로고침을 누르면 상대 기업 커넥터의 DSP 버전을 다시 조회해 표시를 갱신합니다. 이전 버전 가능성이면 Jupiter 행도 추가해야 상대 기업이 협상할 수 있습니다. 이미 있는 버전은 이미 등록됨으로 표시됩니다. 4. "Saturn 버전을 추가했습니다." 안내가 뜨고, 채널 행이 활성 태그로 바뀌며 등록(발행본 배지와 등록일)·호환(추가한 EDC 버전 태그)·공개 범위·계약 중인 기업 칸이 채워집니다. 5. (필요할 때) 정책을 확인하려면 버전 관리의 버전별 계약 정의에서 버전을 펼치고 접근 정책·계약 정책의 정책 상세 보기를 누릅니다. 6. (필요할 때) 나중에 호환되는 다른 버전을 더하려면 해당 행의 버전 관리를 열어 버전별 계약 정의 오른쪽 위 호환 버전 추가를 누릅니다.

끝나면 이렇게 보입니다 ​

  • 내 엔드포인트 카드 표의 채널 행이 활성이고, 발행본 배지(v{n})와 등록일이 보입니다.
  • 파트너와 이 API로 계약을 시작하거나 받으려면 파트너 관계 카드 오른쪽 위 관계 추가를 씁니다. 관계를 만들면 상대 API 연결과 내 API 연결 진행 상황이 관계 테이블 행에 쌓입니다. → 파트너 제품 찾아서 계약하고 받기
  • 파트너는 이제 카탈로그에서 우리 API를 봅니다. 디지털 트윈 레지스트리 API라면 제품 관리 → 탐색에서 우리 BPNL로 제품을 찾을 수 있습니다. → 파트너가 우리 제품을 찾을 수 있게 하기

안 되면 ​

  • 등록 버튼이 없고 "엔드포인트 API 등록과 버전 추가는 조직 소유자만 할 수 있습니다."가 보입니다 → 멤버 계정입니다. 소유자에게 API 이름을 알려 요청하세요.
  • "버전 추가에 실패했습니다." → 공유 → 데이터스페이스의 연결 상태를 확인하고, 정상인데도 반복되면 문의하세요.
  • 잘못 만든 항목을 지우고 싶습니다 → 내 엔드포인트 카드 행의 삭제를 누릅니다. 파트너 협상 이력이 있으면 삭제하지 않고 카탈로그에서 숨김으로 숨겨 파트너에게 더 보이지 않고, 이력이 없으면 완전 삭제됩니다("자산과 연결된 모든 EDC 버전의 계약 정의와 전용 정책이 삭제됩니다. 되돌릴 수 없습니다."). 어느 쪽이든 행은 남아 숨김 또는 삭제됨 태그로 보이고, 같은 자리의 등록으로 새 발행본을 만들 수 있습니다. 숨긴 항목은 버전 관리로 확인합니다.

이 안내서는 현재 저장소에 구현된 화면을 기준으로 작성합니다.