지난 콘텐츠에서는 API를 사용하기 위한 API 키 발급 방법에 대해 알아봤습니다. 그러면 이번 콘텐츠에서는 지난번에 이어서 OPEN API를 사용할 때 필요한 API 명세서를 보는 방법에 대해 안내해드리겠습니다. API 명세서가 뭐지? 지난 콘텐츠에서는 API를 사용하기 위한 API 키 발급 방법에 대해 알아봤습니다. 그러면 이번 콘텐츠에서는 지난번에 이어서 OPEN API를 사용할 때 필요한 API 명세서를 보는 방법에 대해 안내해드리겠습니다. API 명세서가 뭐지?
이것은 OPEN API를 호출할 때 필요한 규격 문서라고 할 수 있습니다. 자세히 말하면 OPEN API의 이름·*파라미터·반환값 등의 구문·인증 및 인가 방법·데이터 전달 형식 등 API를 정확하게 호출하여 그 결과를 명확하게 해석하는데 필요한 정보를 일관된 형식으로 기술한 것을 말합니다. 이것은 OPEN API를 호출할 때 필요한 규격 문서라고 할 수 있습니다. 자세히 말하면 OPEN API의 이름·*파라미터·반환값 등의 구문·인증 및 인가 방법·데이터 전달 형식 등 API를 정확하게 호출하여 그 결과를 명확하게 해석하는데 필요한 정보를 일관된 형식으로 기술한 것을 말합니다.
*파라미터: 소프트웨어나 시스템상의 동작에 영향을 주고 외부에서 투입되는 데이터를 말하며, 이를 활용하여 소프트웨어나 시스템을 작동시키기 때문에 다양한 활용도를 가진다 * 파라미터: 소프트웨어나 시스템상의 동작에 영향을 주고 외부에서 투입되는 데이터를 말하며, 이를 활용하여 소프트웨어나 시스템을 작동시키기 때문에 다양한 활용도를 갖는다
인기글
API 명세서를 작성하면 어떤 장점이 있을까요? API 명세서를 작성하면 어떤 장점이 있을까요?
인터페이스 개발 및 문서화 과정에서 다음과 같은 장점이 있기 때문에 서로 다른 클라우드 서비스 간 연동에 있어 API 명세서의 필요성이 증대되고 있습니다. 1) 결과를 해석하기 위한 필수 정보만을 간결하게 포함하고 있어 API 사용 방법을 파악하는 것이 용이합니다 2) 시스템을 해석할 수 있는 형식으로 작성된 경우 API 명세서를 이용하여 쉽게 소스 코드를 생성할 수 있습니다 3) 다양한 프로그래밍 언어로 인터페이스를 제공할 필요가 있는 경우 라이브러리 및 문서를 개별적으로 관리하지 않고 통합 관리할 수 있습니다 그럼 API 명세서는 어떻게 확인하는 걸까요? – 틸코블렛API로확인! 인터페이스 개발 및 문서화 과정에서 다음과 같은 장점이 있기 때문에 서로 다른 클라우드 서비스 간 연동에 있어 API 명세서의 필요성이 증대되고 있습니다. 1) 결과를 해석하기 위한 필수 정보만을 간결하게 포함하고 있어 API 사용 방법을 파악하는 것이 용이합니다 2) 시스템을 해석할 수 있는 형식으로 작성된 경우 API 명세서를 이용하여 쉽게 소스 코드를 생성할 수 있습니다 3) 다양한 프로그래밍 언어로 인터페이스를 제공할 필요가 있는 경우 라이브러리 및 문서를 개별적으로 관리하지 않고 통합 관리할 수 있습니다 그럼 API 명세서는 어떻게 확인하는 걸까요? – 틸코블렛API로확인!
API 명세서를 확인하기 전에 사용하고자 하는 OPEN API를 선택해야 합니다. 틸코블렛은 데이터 제공 기관별 또는 용도별 필터링 기능을 제공하고 있기 때문에 원하는 인터페이스를 빠르게 선택할 수 있습니다. API 명세서를 확인하기 전에 사용하고자 하는 OPEN API를 선택해야 합니다. 틸코블렛은 데이터 제공 기관별 또는 용도별 필터링 기능을 제공하고 있기 때문에 원하는 인터페이스를 빠르게 선택할 수 있습니다.
*출처 : 틸코블렛 홈페이지 *출처 : 틸코블렛 홈페이지
여러 API 중 운전면허 진위여부 API를 선택하여 자세한 내용을 살펴보겠습니다. API를 선택한 후에는 해당 API의 내용과 가격 플랜을 확인할 수 있습니다. 또한 API를 호출하기 위해 어떤 정보를 입력해야 하는지, 결과는 어떤 형태로 변환되는지도 알 수 있습니다. 여러 API 중 운전면허 진위여부 API를 선택하여 자세한 내용을 살펴보겠습니다. API를 선택한 후에는 해당 API의 내용과 가격 플랜을 확인할 수 있습니다. 또한 API를 호출하기 위해 어떤 정보를 입력해야 하는지, 결과는 어떤 형태로 변환되는지도 알 수 있습니다.
*출처 : 틸코블렛 홈페이지 *출처 : 틸코블렛 홈페이지
1) Request 부분 Request 요청 부분부터 살펴보겠습니다. Header에는 Rest API를 호출하기 위한 API-KEY와 ENC-KEY가 필요합니다. API-KEY에는 발행된 32자리 문자열을 입력하십시오. ENC-KEY에는 RSA 공개키로 암호화된 AES 개인키 값이 포함되어야 합니다. 틸코블렛은 *깃허브(GitHub)를 통해 샘플 코드를 제공하고 있기 때문에 틸코블렛 API를 사용하고자 하는 기업은 크게 어렵지 않게 API를 사용할 수 있습니다. 1) Request 부분 Request 요청 부분부터 살펴보겠습니다. Header에는 Rest API를 호출하기 위한 API-KEY와 ENC-KEY가 필요합니다. API-KEY에는 발행된 32자리 문자열을 입력하십시오. ENC-KEY에는 RSA 공개키로 암호화된 AES 개인키 값이 포함되어야 합니다. 틸코블렛은 *깃허브(GitHub)를 통해 샘플 코드를 제공하고 있기 때문에 틸코블렛 API를 사용하고자 하는 기업은 크게 어렵지 않게 API를 사용할 수 있습니다.
Git: 소스 코드를 관리할 때 주로 사용되는 버전 관리 프로그램*GitHub: 온라인에 데이터를 저장할 수 있는 사이트. 백업이 기본 기능이지만 단순히 저장만 하는 것이 아니라 다른 사용자들과 코드를 공유하여 하나의 프로그램을 함께 제작하는 것도 가능합니다 Git: 소스 코드를 관리할 때 주로 사용되는 버전 관리 프로그램*GitHub: 온라인에 데이터를 저장할 수 있는 사이트. 백업이 기본 기능이지만 단순히 저장만 하는 것이 아니라 다른 사용자들과 코드를 공유하여 하나의 프로그램을 함께 제작하는 것도 가능합니다
2) Body부분 2) Body부분
*출처 : 틸코블렛 홈페이지 *출처 : 틸코블렛 홈페이지
그러면 계속해서 Body 부분을 살펴보도록 하겠습니다. API를 원활하게 구동시키기 위해 Body에 들어가는 데이터는 API마다 다르지만 지금 보고 있는 운전면허 진위조회에서는 BirthDate, Name, LicNumber 등 4개의 데이터가 필요합니다. 각 항목에 대한 데이터 유형과 설명이 있으며 오른쪽에는 필수 여부가 표기되어 있는 것을 확인할 수 있습니다. Special Number는 필수 파라미터가 아니기 때문에 적어도 3개의 데이터가 필요합니다. 그러면 계속해서 Body 부분을 살펴보도록 하겠습니다. API를 원활하게 구동시키기 위해 Body에 들어가는 데이터는 API마다 다르지만 지금 보고 있는 운전면허 진위조회에서는 BirthDate, Name, LicNumber 등 4개의 데이터가 필요합니다. 각 항목에 대한 데이터 유형과 설명이 있으며 오른쪽에는 필수 여부가 표기되어 있는 것을 확인할 수 있습니다. Special Number는 필수 파라미터가 아니기 때문에 적어도 3개의 데이터가 필요합니다.
*출처 : 틸코블렛 홈페이지 *출처 : 틸코블렛 홈페이지
그런데 LicNumber와 SpecialNumber에는 Description에 암호화라는 문구가 적혀 있습니다. 여기서 암호화란 앞서 말씀드린 두 가지 암호화 중 AES 암호화를 의미합니다. 헤더에 있는 ENC-KEY는 RSA 암호화를 의미하며, Body의 파라미터를 AES 암호화할 때 사용되는 키가 AES Secret Key입니다. 이 Secret Key를 RSA 암호화한 값이 헤더의 ENC-KEY에 들어가는 것입니다. 3) Response 부분에서 LicNumber와 SpecialNumber에는 Description에 암호화라는 문구가 적혀 있습니다. 여기서 암호화란 앞서 말씀드린 두 가지 암호화 중 AES 암호화를 의미합니다. 헤더에 있는 ENC-KEY는 RSA 암호화를 의미하며, Body의 파라미터를 AES 암호화할 때 사용되는 키가 AES Secret Key입니다. 이 Secret Key를 RSA 암호화한 값이 헤더의 ENC-KEY에 들어가는 것입니다. 3) Response부분
*출처 : 틸코블렛 홈페이지 *출처 : 틸코블렛 홈페이지
스크롤을 하면 이번에는 Response, 즉 API 호출 결과에 대한 설명이 나와 있습니다. 어떤 항목이 반환되는지 미리 확인할 수 있습니다. 다른 API도 동일한 방법으로 명세서를 참고해주세요. 빠르고 안전한 데이터 연결 서비스, 틸코블렛! 스크롤을 하면 이번에는 Response, 즉 API 호출 결과에 대한 설명이 나와 있습니다. 어떤 항목이 반환되는지 미리 확인할 수 있습니다. 다른 API도 동일한 방법으로 명세서를 참고해주세요. 빠르고 안전한 데이터 연결 서비스, 틸코블렛!
틸코블렛의 API 사용법 가이드와 함께라면 API를 활용해 쉽게 새로운 서비스를 개발할 수 있습니다. 틸코블렛 API는 클라이언트에서 서버로 전송되는 모든 프로세스의 네트워크 패킷을 재구현하여 전송하기 때문에 해당 인터페이스를 사용할 때 속도 저하를 걱정할 필요가 없습니다. 이를 통해 기업 비즈니스에 틸코블렛 API를 연계할 경우 서비스에 필요한 데이터가 기업이 제작한 서비스에 빠르게 표시되는 것을 확인할 수 있을 것입니다. 틸코블렛의 API 사용법 가이드와 함께라면 API를 활용해 쉽게 새로운 서비스를 개발할 수 있습니다. 틸코블렛 API는 클라이언트에서 서버로 전송되는 모든 프로세스의 네트워크 패킷을 재구현하여 전송하기 때문에 해당 인터페이스를 사용할 때 속도 저하를 걱정할 필요가 없습니다. 이를 통해 기업 비즈니스에 틸코블렛 API를 연계할 경우 서비스에 필요한 데이터가 기업이 제작한 서비스에 빠르게 표시되는 것을 확인할 수 있을 것입니다.
RSA, AES 이중 암호화로 안전한 개인정보 보호가 가능한 틸코블렛 API! 빠른 데이터 연결과 강력한 보안이 가능한 API 서비스를 찾고 있는 기업이라면 틸코블렛 API 상품관을 방문해 보세요. 틸코블렛은 금융, 세무 등 다양한 카테고리에 해당하는 150여개의 API 서비스를 보유하고 있어 기업들은 비즈니스에 적합한 API를 자유롭게 이용할 수 있습니다. RSA, AES 이중 암호화로 안전한 개인정보 보호가 가능한 틸코블렛 API! 빠른 데이터 연결과 강력한 보안이 가능한 API 서비스를 찾고 있는 기업이라면 틸코블렛 API 상품관을 방문해 보세요. 틸코블렛은 금융, 세무 등 다양한 카테고리에 해당하는 150여개의 API 서비스를 보유하고 있어 기업들은 비즈니스에 적합한 API를 자유롭게 이용할 수 있습니다.