Postman | 사용법, API 활용 예제 (공공데이터 API)
정라잇 |
요약
포스트맨(Postman) 은 API 결과값을 받을 수 있는 프로그램입니다
일반적으로는 개발을 해야 API 를 활용할 수 있지만 일반인도 기본적인 방법만 알면
포스트맨으로도 충분히 데이터를 출력할 수 있고
개발자가 데이터 테스트만 할 경우는 테스트 용도로 활용할 수 있어
아주 유용한 도구로 활용할 수 있습니다.
인증키 등록
업체마다 API 사용방법이 달라 맞춰서 사용해야 합니다.
예로 토큰 인증을 GET 으로 받는지, Authorization 으로 받는지 체크해보세요
Authorization 인증
Bearer Token 을 사용한다면 API 문서에 힌트가 있을겁니다.
다른 인증 방식도 마찬가지입니다.
프로그램 언어로 적용
Postman으로 정상적으로 값을 출력할 수 있게 되었다면
프로그램 언어로 값을 정제하여 활용할 수 있다는 이야기입니다.
일반적으로는 CURL 기법으로 자료를 주고받으면서 활용할 수 있으며
Java, PHP, Node JS, C# 등 메이저 언어에서는 기본적으로 활용할 수 있습니다.
<?php
$url = "http://localhost:8000";
$body_data = array(
"data1" => "test1",
"data2" => "test2"
);
$body = json_encode(body_data);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HEADER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec ($ch);
?>에러 체크사항
- 아이피 허용을 했는지 체크해보세요
- A 토큰을 사용해야 하는데 B 토큰을 사용했는지 체크해보세요
- 토큰이 정상적으로 활성화 되었는지 체크해보세요
- 필수 파라미터 값을 추가했는지 체크해보세요
- 처음부터 다시 복사 붙여넣기 해보세요
예제
직업훈련포털 hrd.go.kr
https://www.hrd.go.kr/jsp/HRDP/HRDPO00/HRDPOA68/HRDPOA68_1.jsp?authKey={공공데이터}&returnType=XML&outType=1&pageNum=1&pageSize=20&srchTraStDt=20211001&srchTraEndDt=20231231&sort=ASC&sortCol=TOT_FXNUM&srchKeco1=01&srchTraArea1=11