OSE-API Generator 9

내년 유지보수 계약서에, 지금 쓰고 있는 API 연동도 들어가 있나요?

안녕하세요. 오상테크놀로지입니다.​연말이 되면 내년 홈페이지 유지보수 계약을 준비하시는 기관이 많습니다.그런데 과업 범위를 보면 화면 수정, 게시판, 서버 점검은 꼼꼼히 적혀 있는데 API 연동은 한 줄도 없는 경우가 종종 있습니다.오늘은 운영 중인 API 연동을 유지보수 계약에 어떻게 담으면 좋을지 말씀드리겠습니다.​📌 계약에 없으면 '누구 일인지'부터 다투게 됩니다상대 기관이 API를 바꾸거나 연동이 멈췄을 때, 계약서에 해당 내용이 없으면 유지보수 업체는 "범위 밖"이라고 답할 수 있습니다.그 사이 홈페이지의 예약이나 조회 기능은 멈춰 있고, 담당자는 별도 계약을 서둘러 준비해야 합니다.처음 연동을 만든 업체와 지금 유지보수 업체가 다르다면 이런 공백은 더 쉽게 생깁니다.​​✅ 과업 범위에 적어 ..

API 연동, 정보보호 담당 부서의 검토는 개발이 끝난 뒤에 받고 계신가요?

안녕하세요. 오상테크놀로지입니다.​API 연동 일정을 세울 때 보안 검토는 보통 맨 끝에 들어갑니다.개발과 테스트를 마치고, 운영에 붙이기 직전에 정보보호 담당 부서에 검토를 요청하는 순서입니다.그런데 이 순서 때문에 다 만든 연동을 다시 고치는 일이 생각보다 자주 생깁니다. 오늘은 보안 검토를 언제, 무엇부터 받으면 좋을지 말씀드리겠습니다.​📌 끝에서 걸리면 되돌아가는 길이 깁니다검토 단계에서 "이 항목은 내보내면 안 됩니다", "이 방식으로는 외부 접속을 열 수 없습니다"라는 의견이 나오면 설계부터 다시 봐야 합니다.주고받는 항목이 바뀌면 상대 기관도 함께 고쳐야 하고, 접속 방식이 바뀌면 서버 설정과 일정이 다시 잡힙니다.개발 업체도, 병원 담당자도, 상대 기관도 같은 일을 두 번 하게 됩니다.오..

우리 병원의 진료과 코드와 상대 기관의 코드가 다르다면, API 연동은 어떻게 맞출까요?

안녕하세요. 오상테크놀로지입니다.​API 연동을 시작하면 생각보다 일찍 마주치는 문제가 있습니다.같은 ‘정형외과’인데 우리 병원 시스템의 코드와 상대 기관이 쓰는 코드가 다른 경우입니다.연결은 됐는데 화면에 엉뚱한 진료과가 나온다면, 대부분 이 코드가 맞지 않아서입니다. 오늘은 연동 전에 코드를 어떻게 맞추면 좋을지 말씀드리겠습니다.​📌 같은 말, 다른 코드진료과뿐 아니라 예약 상태, 성별, 검사 종류처럼 짧은 코드로 주고받는 값은 기관마다 정하는 방식이 다릅니다.한쪽은 숫자로, 다른 쪽은 영문 약자로 쓰기도 합니다.한쪽에는 있는 값이 다른 쪽에는 아예 없는 경우도 있습니다. 우리 병원에만 있는 센터나 클리닉이 대표적입니다.​​✅ 코드 대응표를 먼저 만듭니다· 주고받을 항목마다 우리 쪽 코드와 상대 쪽..

API 연동을 시험할 때, 혹시 실제 환자 정보로 테스트하고 계시지는 않나요?

안녕하세요. 오상테크놀로지입니다.​API 연동을 준비하다 보면 시험 단계에서 이런 말이 나옵니다.“실제 데이터로 해 봐야 확실하지 않을까요?”맞는 말처럼 들리지만, 병원에서 실제 데이터는 곧 환자 정보입니다. 오늘은 시험용 데이터를 어떻게 준비하면 좋은지 말씀드리겠습니다.​📌 시험 환경은 운영 환경보다 덜 지켜집니다시험 서버는 여러 사람이 드나들고, 접근 권한도 느슨하게 열어 두는 경우가 많습니다.상대 업체 개발자가 접속하기도 하고, 시험이 끝난 뒤에도 데이터가 그대로 남아 있기 쉽습니다.이런 곳에 실제 환자 이름과 연락처, 진료 기록이 들어가 있다면 운영 서버를 아무리 잘 지켜도 빈틈이 생깁니다.​​✅ 시험용 데이터는 이렇게 준비합니다· 이름·연락처·주민번호 같은 항목은 실제처럼 보이지만 실제가 아닌..

연동한 API가 밤사이 멈췄다면, 다음 날 아침 누가 가장 먼저 알게 되나요?

안녕하세요. 오상테크놀로지입니다.​홈페이지의 진료 예약, 의료진 일정, 검사 결과 조회는 병원 안 시스템과 API로 연결되어 있는 경우가 많습니다.이 연결이 밤사이 끊기면, 아침에 가장 먼저 알게 되는 사람은 누구일까요?대부분은 전화를 건 환자이고, 그다음이 그 전화를 받은 원무팀입니다. 오늘은 이 순서를 바꾸는 방법을 말씀드리겠습니다.​📌 홈페이지는 열리는데, 내용만 비어 있는 장애API 장애는 홈페이지 전체가 멈추는 장애와 다릅니다.첫 화면은 멀쩡히 열리고, 예약 버튼을 눌렀을 때만 빈 화면이 나오거나 "잠시 후 다시 시도해 주세요"가 뜹니다.그래서 홈페이지가 열리는지만 확인하는 감시로는 알아차리지 못합니다.​​⚙️ 사람보다 먼저 알아차리게 하려면· API마다 정해진 간격으로 시험 호출을 보내, 정..

협력 업체와의 API 연동을 끝낼 때, 연결만 끊으면 정리가 끝나는 걸까요?

안녕하세요. 오상테크놀로지입니다.​API 연동은 시작할 때 많은 준비를 합니다. 어떤 데이터를 줄지, 인증키는 어떻게 관리할지 꼼꼼히 정합니다.그런데 계약이 끝나거나 서비스를 바꾸면서 연동을 끝낼 때는 생각보다 준비가 적습니다.오늘은 API 연동을 끝낼 때 함께 정리해야 할 것들을 말씀드리겠습니다.​📌 연결을 끊었다고 끝난 것이 아닙니다연동을 종료하면 보통 상대 업체에 "이제 호출하지 마세요"라고 알리는 것으로 마무리합니다.하지만 우리 쪽에서 열어 둔 통로가 그대로라면, 상대가 호출하지 않을 뿐 여전히 호출할 수 있는 상태입니다.쉽게 말해서, 이사 간 세입자에게 열쇠를 돌려받지 않은 것과 같습니다.​​✅ 우리 쪽에서 닫아야 할 것들· 상대 업체에 발급했던 인증키를 폐기했는지· 상대 서버 주소만 들어올 ..

API 연동을 맡았던 담당자가 바뀌어도, 다음 사람이 이어받을 수 있게 남아 있나요?

안녕하세요. 오상테크놀로지입니다.​API 연동은 처음 붙일 때보다, 몇 년이 지나 다시 손대야 할 때가 더 어렵습니다.그 사이에 연동을 맡았던 직원도, 상대 기관의 담당자도 바뀌어 있기 때문입니다.오늘은 담당자가 바뀌어도 연동이 끊기지 않으려면 무엇을 남겨 두어야 하는지 살펴보겠습니다.​📌 "그건 전임자만 알아요"가 가장 위험합니다연동이 잘 돌아가는 동안에는 아무도 문서를 찾지 않습니다.그러다 상대 기관이 주소를 바꾸거나, 인증키를 새로 발급하거나, 응답 형식을 고치면 그때서야 찾게 됩니다.이때 기록이 메일함과 개인 메모에 흩어져 있으면, 원인을 찾는 데만 한참이 걸립니다.​​✅ 연동마다 한 장으로 남겨 둘 것· 무엇을 주고받는지 — 어떤 데이터가 어느 방향으로 오가는지· 어디로 연결되는지 — 운영 주..

API 연동, 운영 서버에 붙이기 전에 어떤 테스트를 해 보셨나요?

안녕하세요. 오상테크놀로지입니다.​API 연동은 개발이 끝났다고 해서 끝난 것이 아닙니다.테스트 서버에서 잘 되던 연동이 운영 서버에 붙이자마자 멈추는 일이 실제로 있습니다.오늘은 운영에 붙이기 전에 확인해 두면 좋은 것들을 정리해 드리겠습니다.​📌 정상 응답만 확인하고 끝내지 않습니다​연동 테스트를 하면 보통 "요청을 보냈더니 데이터가 잘 왔다"까지만 확인합니다.하지만 운영에서 문제가 되는 쪽은 대부분 그 반대입니다.​✅ 상대 시스템이 응답하지 않을 때 홈페이지는 어떻게 보이는가✅ 값이 비어 있거나 형식이 다르게 올 때 화면이 깨지지 않는가✅ 같은 요청이 두 번 들어가도 데이터가 중복되지 않는가​👉 정상일 때보다 비정상일 때의 모습을 먼저 정해 두는 편이 안전합니다.​​🔐 인증 정보와 허용 범위를..

협력 업체가 "API로 데이터를 달라"고 한다면, 무엇부터 정해야 할까요?

안녕하세요. 오상테크놀로지입니다.​지금까지 API 연동 이야기는 주로 "우리 홈페이지가 병원 시스템에서 정보를 가져오는" 쪽이었습니다.그런데 요즘은 반대 방향의 요청도 자주 들어옵니다.​"협력 업체에서 진료과 정보를 API로 받아 가고 싶다고 합니다.""건강검진 예약 대행 업체가 예약 가능 시간을 API로 달라고 합니다."​요청은 한 줄이지만, 정해야 할 것은 생각보다 많습니다.오늘은 우리 기관이 데이터를 내어주는 쪽일 때 먼저 정해 둘 것들을 정리해 드리겠습니다.​📌 어떤 데이터를, 어디까지 줄지부터 적습니다​가장 먼저 할 일은 "무엇을 줄 것인가"를 문서로 적는 것입니다.진료과 이름과 위치처럼 이미 홈페이지에 공개된 정보인지, 예약 현황처럼 내부 정보인지에 따라 이후 준비가 완전히 달라집니다.​✅ ..