다른 소프트웨어가 내 데이터를 읽도록 허용하는 것
API 스튜디오: 한 번에 하나의 화면을 게시하고, 키를 발급하고, 해당 키를 주소에 고정하고, 동일한 방식으로 AI 에이전트용 MCP 서버로 게시할 수 있습니다.
조만간 TRANXACT 외부에서 여러분의 데이터가 필요한 상황이 발생할 수 있습니다. 보고 도구, 파트너 시스템, 가격표가 필요한 웹사이트, 또는 여러분의 사업에 대한 질문을 받은 AI 에이전트 등이 그 예입니다. 플랫폼 메뉴의 API 스튜디오에서 화면 하나, 열 하나씩 데이터를 허용할지 여부를 결정할 수 있습니다.
누군가가 공개하기 전까지는 외부에서 접근할 수 있는 것이 아무것도 없습니다. 모든 것을 열어주는 설정도 없고, 모든 것에 접근할 수 있는 키도 없습니다. 완전히 새로 배포된 시스템은 API 인터페이스가 전혀 없으며, 이것이 바로 활성화되기를 기다리는 상태가 아니라 처음부터 갖춰야 할 올바른 시작점입니다.
네 가지 결정은 순서대로 다음과 같습니다.
| 무엇 | 그것이 결정하는 것 | 보통 누가 만드는가 |
|---|---|---|
| 노출 | 해당 화면 하나가 회사 밖으로 완전히 반출될 수도 있습니다. 어떤 열, 어떤 행의 데이터가 반출될지, 그리고 어떤 내용이 다시 기록될 수 있을지 여부까지 모두 결정될 것입니다. | 데이터 소유자가 누구든 |
| 고객 | 해당 소프트웨어가 존재하는지, 이름은 무엇인지, 누구에게 문의해야 하는지, 그리고 어떤 사용자 계정으로 작동하는지 알고 싶습니다. | 통합을 담당하는 사람 |
| 보조금 | 이 고객이 이러한 동사들을 통해 그러한 노출에 도달할 수 있도록 말입니다. | 통합을 담당하는 사람 |
| 허용된 주소 | 키가 제시될 수 있는 위치는 브라우저, 호스트, 서버 주소 또는 네트워크 등 다양합니다. | 통합을 담당하는 사람 |
이 플랫폼은 이를 위해 세 가지 역할을 제공하며, 각 역할을 의도적으로 분리합니다. API 게시자는 공개 가능한 항목을 결정하며 키를 발급할 수 없습니다. API 등록자는 키를 발급하지만 노출 권한을 생성할 수 없습니다. API 검토자는 모든 내용을 검토하지만 아무것도 변경하지 않습니다. 한 사람이 모든 권한을 보유하고 급여 테이블을 게시하고 해당 테이블을 읽을 수 있는 키를 자신에게 발급하는 것은 모든 단계가 일반적인 관리 변경처럼 보이는, 완전히 비공개적인 내보내기 경로입니다.
화면 게시
- Open Platform → API Studio를 선택하고 화면을 고르세요. 목록에는 콘솔에 있는 모든 화면이 제품 자체에서 읽어온 것이므로 이번 릴리스에 포함된 화면도 목록에 있습니다.
- 전송될 수 있는 열에 체크 표시를 하세요. 체크 표시가 없는 항목은 절대 전송되지 않습니다. 목록에도, 개별 레코드에도, 쓰기 작업이 반환하는 최종 결과물에도 포함되지 않습니다. 애초에 모든 항목은 의도적으로 체크 표시가 되어 있지 않습니다.
- 어떤 작업을 수행할지 결정하세요. 읽기는 기본적으로 활성화되어 있으며, 생성, 변경, 삭제는 각각 별개의 결정입니다. 왜냐하면 상대방 시스템이 내 품목 마스터를 읽도록 허용하는 것과 상대방 시스템이 품목 마스터를 삭제하도록 허용하는 것은 전혀 다른 작업이기 때문입니다.
- 선택적으로 행을 제한할 수 있습니다. 예를 들어, 게시된 송장만 표시하거나 올해 송장만 표시할 수 있습니다. 이 필터는 모든 목록 화면에서 사용되는 동일한 필터이며, 모든 통화 시 서버에서 적용되므로 발신자가 보내는 어떤 정보로도 범위를 넓힐 수 없습니다.
- 저장해 두세요. 이건 초안일 뿐이고, 초안은 아무런 성과도 가져오지 못합니다. 진심으로 원할 때 비로소 완성된 글을 만들어 보세요.
- 키를 다른 사람에게 주기 전에 미리 보기를 누르세요. 파트너가 받게 될 내용과 제외된 열의 수를 정확하게 확인할 수 있습니다.
소프트웨어 등록
클라이언트는 소프트웨어에 대한 기록입니다. 소프트웨어의 이름, 기능, 문의 담당자, 그리고 가장 중요한 것은 어떤 사용자 계정으로 작동하는지에 대한 정보가 포함됩니다. 클라이언트 키가 수행하는 모든 호출은 해당 사용자 계정으로 이루어집니다. 해당 사용자가 할 수 없는 작업은 클라이언트 키도 할 수 없습니다.
화면에서 가장 중요한 필드는 바로 그 부분이며, 그렇기 때문에 접근 권한 노출은 항상 제한만 할 뿐 확대는 불가능합니다. 관리자에게 권한을 부여하는 것이 편리하다고 해서, 해당 업무에 필요한 가장 제한적인 역할을 가진 사용자에게만 키를 지정해야 합니다.
열쇠는 발급 시 한 번만 표시되고 다시는 표시되지 않습니다. 새 열쇠를 발급하면 기존 열쇠는 즉시 작동을 멈춥니다. 열쇠는 고객 정보를 삭제하지 않고 회수할 수 있으므로, 등록 기록에는 누가 언제 열쇠를 회수했는지가 계속 기록됩니다.
열쇠가 사용될 수 있는 곳
허용된 주소가 없는 키로는 아무것도 할 수 없습니다. 주소가 지정되지 않은 경우, 아직 접근할 수 없다는 의미이며, 어디에서도 접근할 수 없다는 의미는 아닙니다. 유출된 키가 전 세계 모든 노트북에서 작동할 수 있다면 그것이 바로 위험의 전부이기 때문입니다. 접근 방식은 브라우저 출처, 참조 호스트, 단일 주소 또는 CIDR 형식의 네트워크 등 네 가지가 있습니다.
클라이언트는 어디에서든 사용 가능하다고 표시될 수 있으며, 실제로 송신 주소가 변경된 파트너의 경우처럼 그렇게 표시하는 것이 맞는 경우도 있습니다. 이는 기본 설정이 아니라 경고 메시지와 함께 의도적으로 변경하는 것입니다.
통합 작업을 하는 사람에게 무엇을 보내야 할까요?
스튜디오는 네 가지 주소를 출력합니다. 기본 주소는 /api/v1이고, 키는 Authorization: Bearer 헤더에 포함되며, /api/v1/resources에는 이 키를 사용하여 접근할 수 있는 리소스 목록이 있고, /api/v1/openapi.json은 OpenAPI 3.1 문서와 동일합니다.
이 두 가지 모두 요청하는 키로부터 생성됩니다. 파트너에게 호출할 수 없는 엔드포인트 40개가 나열된 문서가 제공되는 경우는 절대 없습니다. 파트너에게 제공되는 문서는 호출 가능한 엔드포인트만 정확하게 설명하며, 요청 처리기가 확인하는 동일한 행으로 구성되기 때문에 거부될 경로를 설명할 수 없습니다.
AI 에이전트에 대한 동일한 데이터
주소 /api/v1/mcp는 모델 컨텍스트 프로토콜(MCP) 서버입니다. 이 서버에 연결하는 에이전트는 키가 수행할 수 있는 각 작업에 대한 도구만 제공받으며, 그 외의 다른 작업에는 사용할 수 없습니다. 즉, 아무도 공개하지 않은 데이터에 대한 도구나 아무도 권한을 부여하지 않은 동사에 대한 도구는 제공되지 않습니다. 이는 개발자가 아닌 모델을 위해 설명된 동일한 공개 정보이므로, 둘 사이에 불일치가 발생할 염려가 없습니다.
클라이언트 측에 MCP 지침을 작성하십시오. 모델에게 이러한 도구가 샌드박스가 아닌 실제 원장에 접근한다는 사실을 알리는 유일한 곳이며, 여기서 말하는 주문이 구매 주문을 의미하는 것이지 판매 주문을 의미하는 것이 아님을 명시할 수 있는 유일한 곳입니다.
모든 통화에서 발생하는 일
게시된 호출은 데이터베이스에 대한 바로 가기가 아닙니다. 인증 절차를 거치고, 노출 및 권한 부여 여부를 확인한 후, 플랫폼 자체 API를 통해 사용자의 실행 계정으로 호출됩니다. 이는 콘솔에서 사용하는 것과 동일한 경로입니다. 회사 범위 지정, 사업부 범위 지정, 장소 제한, 마감 기간, 게시 규칙, 사용자 정의 필드, 사용자 정의 로직, 편집 가능성 및 감사 추적은 모두 동일한 코드가 실행되므로 동일하게 적용됩니다.
모든 호출은 허용 여부와 거부 사유와 함께 기록됩니다. 해당 로그는 플랫폼 → API 스튜디오 → API 호출 로그에서 확인할 수 있으며, 허용되지 않은 주소에서 키가 제시된 경우가 가장 흥미로운 부분입니다.
작동하지 않을 때
| 파트너가 보는 것 | 그것이 의미하는 바는 |
|---|---|
| 해당 API 키를 인식할 수 없습니다. | 잘못된 키이거나, 그 이후로 새 키가 발급되었습니다. |
| 이 API 키에는 허용된 주소가 없습니다. | 어디에서 사용될지는 아직 아무도 말하지 않았습니다. |
| 이 API 키는 여기에서 사용할 수 없습니다. | 실제로 도착한 발신지와 주소를 알려줍니다. 대개 파트너사가 서버를 이전한 경우입니다. |
| 여기에는 X로 게시된 것이 없습니다. | 이름이 잘못되었거나, 해당 키에 대한 노출 권한이 부여되지 않았거나, 아직 초안 단계입니다. |
| 이 키로는 X를 생성할 수 없습니다. | 해당 노출이나 보조금은 그 동사를 허용하지 않습니다. |
| 당신은 X를 볼 권한이 없습니다. | 보조금은 문제가 없지만, 운영 사용자 계정에 문제가 있습니다. 스튜디오는 파트너가 이러한 정보를 찾기 전에 미리 목록을 제공합니다. |
클라이언트 목록에는 상태뿐만 아니라 준비 상태 열도 표시됩니다. 클라이언트가 활성화되어 있고 키를 보유하고 있더라도 아무것도 연결되지 않을 수 있기 때문입니다. 실행할 사용자 계정이 없거나, 허용된 주소가 없거나, 아무것도 승인되지 않은 경우입니다. 모든 호출이 거부되는데도 '활성'으로 표시되는 상황이 오후 내내 벌어집니다.