25
iOS Kweather OpenApi Library Guide Version 1.0.0

[20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

  • Upload
    others

  • View
    6

  • Download
    0

Embed Size (px)

Citation preview

Page 1: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

iOS Kweather OpenApi Library Guide

Version 1.0.0

Page 2: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

목 차

1. Release History 1

2. Library 적용 절차 2

3. Library 인터페이스 6

3.1 국내날씨 6

⑴ 현재날씨 6

⑵ 예보 8

1) 1시간 단위 (72시간) 8

2) 6시간 단위 (3일) 9

3) 12시간 단위 (3일) 10

4) 1일 단위 11

⑶ 생활지수 12

3.2 세계날씨 13

⑴ 현재날씨 13

⑵ 예보 14

1) 1시간 단위 14

2) 일 단위 15

⑶ 기후정보 16

⑷ 생활지수 17

3.3 날씨뉴스 18

3.4 날씨방송 20

⑴ 날씨영상 20

⑵ 방송 썸네일 및 정보리스트 21

3.5 현위치검색 22

3.6 도시명검색 23

Page 3: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 1 -

1. Release History

Date Version Description

2013.09.30 1.0.0 최초 작성

Page 4: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 2 -

2. Library 적용 절차

2.1 권장환경 - Xcode 4.5.x 이상 권장

- Base SDK : iOS 6.0 이상

- iOS Deployment Target iOS : 4.3 이상

2.2. Library 구성 - 헤더파일

> KweatherOpenApi.h

- 라이브러리

> libKweatherOpenApi_1.0.0.a

2.3 참고사항 - Kweather iOS OpenApi는 iOS SDK 6.1 기반으로 작성되었다.

- Kweather iOS OpenApi는 비동기 (Asynchronous) 방식을 사용한다.

- 비동기 방식은 결과를 통보 받을수 있는 KweatherOpenApiDelegate protocol을 구현한 Delegate 객체를

KweatherOpenApi 객체에 설정하여 비동기적으로 결과를 통보받을수 있다.

2.4 Library 적용 방법

⑴ 인증 키 발급 및 Library 다운로드 - KweatherOpenApi를 사용하기 위해서는 키 발급 페이지 (http://api.kweather.co,kr)에서 가입 후 원하는

서비스를 신청하여 Client Key를 발급받아야한다.

- Client Key를 발급 받은 후 라이브러리 (iOS)를 다운 받는다.

⑵ Library 적용 - 다운받은 라이브러리파일의 압축을 풀고 KweatherOpenApi를 적용할 프로젝트 내에 'Lib' 폴더를 복사한

다.

- 다음과 같은 Framework가 없다면 추가시킨다.

> Foundation.framework

> CoreGraphics.framework

Page 5: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 3 -

⑶ Library 세부 사용 방법 - KweatherOpenApi.h 파일 import 하기

- initAvailableClientKey 함수를 호출하여 Client Key 유효성 검사하기

- 신청한 항목의 함수를 호출하여 데이터를 얻기

KweatherOpenApi 클래스는 Singleton으로 구현되어 있어, 하나의 어플리케이션에서 한 개의 객체만 사용

하도록 구성되어 있다. 그렇기 때문에 ClientKey 유효성검사는 한번만 수행하면 된다.

KweatherOpenApi를 사용할 클래스에서 헤더파일 (KweatherOpenApi.h)을 Import 시킨다.

ClientKey 유효성 검사를 다음과 같이 수행한다.

KweatherOpenApi *pKweatherOpenApi = [KweatherOpenApi sharedKweatherOpenApi];

[pKweatherOpenApi setDelegate:self];

[pKweatherOpenApi initAvailableClientKey:@"Client_Key"];

비동기 (Asynchronous) 방식으로 KweatherOpenApiDelegate 프로토콜의 아래 메소드를 할당하여 결과를

통보 받아 확인할 수 있다. 그러므로 통보(리턴) 메소드를 사용하기 위해 클래스가

KweatherOpenApiDelegate 프로토콜을 따르게 해야 한다. 클래스 선언부의 상위 클래스 뒤에 프로토콜의

이름에<와>를 붙여서 추가하면 프로토콜을 따르게 할 수 있다.

Page 6: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 4 -

ClientKey 유효성검사 결과 통보 (리턴) 메소드는 다음과 같다.

통보 (리턴) Method Name- (void)kweatherOpenApi:(KweatherOpenApi *)_pKweatherOpenApi didAvailableClientKeyResult:(KweatherO

penApiAvailableKeyFlag)result

result 결과 값은 다음과 같이 정해진다.

※ KweatherOpenApiAvailableKeyFlag

typedef enum

{

KweatherAvailableKey_Fail,

KweatherAvailableKey_Success,

KweatherAvailableKey_NotAvailableKey

} KweatherOpenApiAvailableKeyFlag;

KweatherAvailableKey_Fail 실패

KweatherAvailableKey_Success 성공

KweatherAvailableKey_NotAvailableKey 유효하지 않는 키

KweatherAvailableKey_Success를 리턴 받아야 정상적으로 이용가능하다.

신청한 항목의 메소드를 호출하여서 결과를 통보 받아서 사용 받으면 된다.

Page 7: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 5 -

모든 항목의 호출 메소드는 비동기 (Asynchronous) 방식으로, 호출 메소드와 통보(리턴) 메소드가 각각 정

의되어 있다.

호출 메소드를 요청하면 바로 상태값을 리턴한다. 리턴되는 상태값은 다음과 같다

※ KweatherOpenApiRequestFlag

typedef enum

{

KweatherOpenApiRequest_Success,

KweatherOpenApiRequest_AlreadyUsed,

KweatherOpenApiRequest_UnsupportedApi,

KweatherOpenApiRequest_NotInitAvailable,

KweatherOpenApiRequest_NotAvailableParameter,

KweatherOpenApiRequest_RequestCountOver

} KweatherOpenApiRequestFlag;

KweatherOpenApiRequest_Success Request 요청 성공

KweatherOpenApiRequest_AlreadyUsed Request가 이미 진행중

KweatherOpenApiRequest_UnsupportedApi 지원(신청) 하지 않는 API

KweatherOpenApiRequest_NotInitAvailable ClientKey 유효성 검사를 수행하지 않았거나

실패 또는 유효하지 않는 키

KweatherOpenApiRequest_NotAvailableParameter 요청 메소드 파라마터 오류

KweatherOpenApiRequest_RequestCountOver 호출 카운트 초과

- 호출 메소드 예제 (오늘예보) KweatherOpenApiRequestFlag flag;

KweatherOpenApi *pKweatherOpenApi = [KweatherOpenApi sharedKweatherOpenApi];

[pKweatherOpenApi setDelegate:self]; <- 통보(리턴) 메소드가 호출될 클래스를 지정해주면 된다.

flag = [pKweatherOpenApi get_today_AreaCode:지역코드 withTimeout:5.0f];

- 통보 메소드 예제 (오늘예보)

통보 (리턴) Method Name

- (void)didReturnTodayDictionary:(NSDictionary *)dictData

통보 (리턴) 메소드를 통해 NSDictionary형태의 데이터를 받아 사용할수 있다.

Page 8: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 6 -

3. Library 인터페이스

3.1 국내날씨

⑴ 현재날씨 ① API 호출 메소드

Method Name

- (KweatherOpenApiRequestFlag)get_today_AreaCode:(NSString *)areaCode withTimeout:(CGFloat)timeout

Element Description

areaCode 지역코드

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnTodayDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성  NSString country_ko 국가 이름(한글)    NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)    NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)    NSString city_en 도시 이름(영문)NSString dong_ko 동 이름(한글)    NSString dong_en 동 이름(영문)NSString locale 국내/해외 구분 kma/world  NSString lon 경도    NSString lat 위도    NSString tz time zone UTC:+9:0  NSString date 관측시각정보 YYYYMMDDHH, 2011122613 2011년12월26일13시 NSString dst local time(Summer time) 미적용 NA, 적용시 -1  NSString daynight 낮(D)/밤(N) 구분 국내는 NA, 해외는 D/N  NSString icon 날씨아이콘 1~40  NSString temp 현재기온 ℃(소수점 첫째자리) 소수점 첫째자리로 표출NSString max_temp 일 최고기온(예보) ℃(소수점 첫째자리) 정수로 표출NSString min_temp 일 최저기온(에보) ℃(소수점 첫째자리) 정수로 표출NSString sens_temp 체감온도 ℃(소수점 첫째자리) 소수점 첫째자리로 표출NSString wd_ws 풍향/풍속 36방위, m/s(소수점 첫째자리)  NSString humi 습도 %  NSString rainf 강수량 mm  NSString snowf 적설량 cm  NSString pa 해면기압 hpa(소수점 첫째자리)  NSString badfeel 불쾌지수 0~100  

Page 9: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 7 -

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString pm10 미세먼지농도 0~ 값이 들어올 경우 NA처리NSString wtext 짧은개황    NSString wf_today 오늘개황    NSString wf_tomorrow 내일 개황    NSString wf_week 주간 개황    NSString sunrise 일출 hh:mm  NSString sunset 일몰 hh:mm  NSString moonrise 월출 hh:mm  NSString moonset 월몰 hh:mm  NSString violet 자외선 지수 소수젓 첨째자리  NSString vs 가시거리 Meter(ex 1km > 1000)  

Page 10: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 8 -

⑵ 케이웨더 예보

1) 1시간 단위 (72시간)

① API 호출 메소드

Method Name

- (KweatherOpenApiRequestFlag)get_life_1hr_AreaCode:(NSString *)areaCode withTimeout:(CGFloat)timeout

Element Description

areaCode 지역코드

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnLife_1hrDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성NSString country_ko 국가 이름(한글)    NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)    NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)    NSString city_en 도시 이름(영문)NSString dong_ko 동 이름(한글)    NSString dong_en 동 이름(영문)NSString announce_date 발표시각 2012050321  NSArray life_life1hr_data 1시간예보    

④ life_life1hr_data (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString date 적용 날짜 20120503  NSString icon 날씨아이콘 1~12  NSString icontext 하늘상태 맑음, 구름조금…  NSString temp 기온 ℃(소수점 첫째자리)  NSString humi 습도 69  NSString wd_ws 풍향:풍속 2:04  NSString rainp 강수확률 ℃(소수점 첫째자리) 소수점 첫째자리로 표출NSString rainf 강수량 cm 없으면 na 정수로 표출NSString snowf 강설량 cm 없으면 na 정수로 표출

Page 11: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 9 -

2) 6시간 단위 (3일)

① API 호출 메소드

Method Name

- (KweatherOpenApiRequestFlag)get_life_6hr_AreaCode:(NSString *)areaCode withTimeout:(CGFloat)timeout

Element Description

areaCode 지역코드

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnLife_6hrDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성NSString country_ko 국가 이름(한글)    NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)    NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)    NSString city_en 도시 이름(영문)NSString dong_ko 동 이름(한글)    NSString dong_en 동 이름(영문)NSString announce_date 발표시각 2012050321  NSArray life_life6hr_data 6시간예보    

④ life_life6hr_data (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString quater 적용 시간1-새벽(00~06), 2-아침(06~12),

3-낮(12~18), 4-저녁(18~24) 

NSString date 적용 날짜 20120503  NSString icon 날씨아이콘 1~12  NSString icontext 하늘상태 맑음, 구름조금…  NSString max_temp 최고기온 ℃(소수점 첫째자리)  NSString min_temp 최저기온 ℃(소수점 첫째자리)  NSString max_humi 최고습도 69NSString min_humi 최저습도 69

NSString wd8l_wd8r_ws 풍향1:풍향2:풍속 2:00:04

풍향1,2값이모두들어

있 다면풍 향을 “북-북

동”으로표현할수있다.NSString rainp 강수확률 ℃(소수점 첫째자리)NSString rainf 강수량 cm 없으면 naNSString snowf 강설량 cm 없으면 na

Page 12: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 10 -

2) 12시간 단위 (3일)

① API 호출 메소드

Method Name- (KweatherOpenApiRequestFlag)get_life_12hr_AreaCode:(NSString *)areaCode withTimeout:(CGFloat)timeo

utElement Description

areaCode 지역코드

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnLife_12hrDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성NSString country_ko 국가 이름(한글)    NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)    NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)    NSString city_en 도시 이름(영문)NSString dong_ko 동 이름(한글)    NSString dong_en 동 이름(영문)NSString announce_date 발표시각 2012050321  NSArray life_life12hr_data 12시간예보    

④ life_life12hr_data (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString ampm 적용 시간 1-am, 2-pmNSString date 적용 날짜 20120503NSString icon 날씨아이콘 1~12NSString icontext 하늘상태 맑음, 구름조금…NSString max_temp 최고기온 ℃(소수점 첫째자리)NSString min_temp 최저기온 ℃(소수점 첫째자리)NSString max_humi 최고습도 69NSString min_humi 최저습도 69

NSString wd8l_wd8r_ws 풍향1:풍향2:풍속 2:00:04

풍향1,2값이모두들어있

다면풍향을“북-북동”으

로표현할수있다.NSString rainp 강수확률 ℃(소수점 첫째자리)NSString rainf 강수량 cm 없으면 naNSString snowf 강설량 cm 없으면 na

Page 13: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 11 -

3) 1일 단위

① API 호출 메소드

Method Name- (KweatherOpenApiRequestFlag)get_life_day_AreaCode:(NSString *)areaCode withTimeout:(CGFloat)timeou

tElement Description

areaCode 지역코드

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnLife_DayDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성NSString country_ko 국가 이름(한글)    NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)    NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)    NSString city_en 도시 이름(영문)NSString dong_ko 동 이름(한글)    NSString dong_en 동 이름(영문)NSString announce_date 발표시각 2012050321  NSArray life_lifedays_data 1일예보    

④ life_lifedays_data (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString date 적용 날짜 20120503NSString icon 날씨아이콘 1~12NSString icontext 하늘상태 맑음, 구름조금…NSString max_temp 최고기온 ℃(소수점 첫째자리)NSString min_temp 최저기온 ℃(소수점 첫째자리)NSString max_humi 최고습도 69NSString min_humi 최저습도 69

NSString wd8l_wd8r_ws 풍향1:풍향2:풍속 2:00:04

풍향1,2값이모두들어있

다면풍향을“북-북동”으

로표현할수있다.NSString rainp 강수확률 ℃(소수점 첫째자리)NSString rainf 강수량 cm 없으면 naNSString snowf 강설량 cm 없으면 na

Page 14: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 12 -

⑶ 생활지수 ① API 호출 메소드

Method Name

- (KweatherOpenApiRequestFlag)get_jisu_AreaCode:(NSString *)areaCode withTimeout:(CGFloat)timeout

Element Description

areaCode 지역코드

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnJisuDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성NSString country_ko 국가 이름(한글)    NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)    NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)    NSString city_en 도시 이름(영문)NSString date 업데이트시각 YYYYMMDDHH 2013042514NSArray jisu_data 생활지수    

④ jisu_data (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString name 지수 종류   감기, 나들이, 불쾌, 운동,

자외선NSString level 지수 단계 0~100  NSString text 지수 설명   평소 건강관리에 유의하

세요

⑤ 지수종류

감기 나들이 불쾌 운동 자외선

⑥ 지수단계

불쾌지수 그 외 지수

매우 좋음(10~20) 매우 좋음(90~100)

좋음(30~40) 좋음(70~80)

보통(50~60) 보통(50~60)

나쁨(70~80) 나쁨(30~40)

매우 나쁨(80~100) 매우 나쁨(10~20)

Page 15: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 13 -

3.2 세계날씨

⑴ 현재날씨 ① API 호출 메소드

Method Name- (KweatherOpenApiRequestFlag)get_world_today_AreaCode:(NSString *)areaCode withTimeout:(CGFloat)ti

meoutElement Description

areaCode 지역코드

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnWorld_TodayDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성  NSString country_ko 국가 이름(한글)    NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)    NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)    NSString city_en 도시 이름(영문)NSString locale 국내/해외 구분 kma/world  NSString lon 경도    NSString lat 위도    NSString tz time zone UTC:+9:0  NSString date 관측시각정보 YYYYMMDDHH, 2011122613 2011년12월26일13시NSString dst local time(Summer time) 미적용 NA, 적용시 -1  NSString daynight 낮(D)/밤(N) 구분 국내는 NA, 해외는 D/N  NSString icon 날씨아이콘 1~40  NSString temp 현재기온 ℃(소수점 첫째자리) 소수점 첫째자리로 표출NSString max_temp 일 최고기온(예보) ℃(소수점 첫째자리) 정수로 표출NSString min_temp 일 최저기온(에보) ℃(소수점 첫째자리) 정수로 표출NSString sens_temp 체감온도 ℃(소수점 첫째자리) 소수점 첫째자리로 표출NSString wd_ws 풍향/풍속 36방위, m/s(소수점 첫째자리)  NSString humi 습도 %  NSString pa 해면기압 hpa(소수점 첫째자리)  

Page 16: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 14 -

⑵ 예보

1) 1시간 단위

① API 호출 메소드

Method Name- (KweatherOpenApiRequestFlag)get_world_1hr_AreaCode:(NSString *)areaCode withTimeout:(CGFloat)time

outElement Description

areaCode 지역코드

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnWorld_1hrDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성NSString country_ko 국가 이름(한글)    NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)    NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)    NSString city_en 도시 이름(영문)NSString announce_date 발표시각 2012050321  NSArray hourly_data 1시간예보    

④ hourly_data (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString date 날짜 20111226NSString icon 아이콘 코드 1~40NSString hour 시각 03, 06, 09 …NSString temp 기온 ℃(소수점 첫째자리)NSString humi 습도 %NSString wd:ws 풍향:풍속 36방위, m/sNSString rainp 강수확률 %

NSString rainf 누적강수량cm(~의 경우 앞에 붙으면, 미

만, 뒤에 붙으면 이상)

NSString snowf 누적강수량cm(~가 앞에 붙을 경우 미만,

뒤에 붙을 경우 이상)

Page 17: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 15 -

2) 일 단위

① API 호출 메소드

Method Name- (KweatherOpenApiRequestFlag)get_world_week_AreaCode:(NSString *)areaCode withTimeout:(CGFloat)tim

eoutElement Description

areaCode 지역코드

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnWorld_WeekDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성NSString country_ko 국가 이름(한글)    NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)    NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)    NSString city_en 도시 이름(영문)NSArray weekly_data 1일예보    

④ weekly_data (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString date 날짜 20111226  NSString dow 요일 1~7(일~토)  NSString icon 날씨아이콘 1~40  NSString max_temp 최고기온 ℃(소수점 첫째자리) 정수NSString min_temp 최저기온 ℃(소수점 첫째자리) 정수

Page 18: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 16 -

⑶ 기후정보 ① API 호출 메소드

Method Name- (KweatherOpenApiRequestFlag)get_world_climate_info_AreaCode:(NSString *)areaCode withTimeout:(CGFl

oat)timeoutElement Description

areaCode 지역코드

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnWorld_ClimateInfoDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성NSString country_ko 국가 이름(한글)    NSString country_en 국가 이름(영문)NSArray climate_data 월별기후정보    

④ climate_data (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString month 적용 월 1, 2, 3,…12NSString max_temp 월 평균 최고 기온 20.2NSString min_temp 월 평균 최저 기온 3.8NSString rainf 월 평균 강수량 mm, 16.7NSString raindays 월 평균 강수일수 3NSString Climate 월 기후 특징 텍스트NSString tourtip 월 옷차림 정보 텍스트

Page 19: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 17 -

⑷ 생활지수 ① API 호출 메소드

Method Name- (KweatherOpenApiRequestFlag)get_world_jisu_AreaCode:(NSString *)areaCode withTimeout:(CGFloat)time

outElement Description

areaCode 지역코드

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnWorld_JisuDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성NSString country_ko 국가 이름(한글)    NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)    NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)    NSString city_en 도시 이름(영문)NSString date 업데이트시각 YYYYMMDDHH 2013042514NSArray jisu_data 생활지수    

④ jisu_data (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString name 지수 종류   01NSString level 지수 단계 0~100 80

NSString text 지수 설명   평소 건강관리에 유의하

세요

⑤ 지수종류 ⑥ 지수단계

01 나들이 02 운동

04 불쾌 05 냉방

06 빨래 07 세차

08 불조심 09 부패

10 감기 11 난방

불쾌 지수 그 외 지수

매우 좋음(10~20) 매우 좋음(90~100)

좋음(30~40) 좋음(70~80)

보통(50~60) 보통(50~60)

나쁨(70~80) 나쁨(30~40)

매우 나쁨(80~100) 매우 나쁨(10~20)

Page 20: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 18 -

3.3 날씨뉴스 ① API 호출 메소드

Method Name- (KweatherOpenApiRequestFlag)get_news_NewsCategory:(NSString *)newsCategory withContentsCount:(N

SInteger)contentsCount withTimeout:(CGFloat)timeoutElement Description

newsCategory 뉴스카테고리명

contentsCount 컨텐츠 표출 개수 (최대 20개. 5개 미만을 권장)

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnNewsDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString category 기사 카테고리NSArray news_data 날씨뉴스데이터

④ news_data (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString title 대제목NSString subtitle 소제목NSString date 작성일NSString wr_name 작성자NSString wr_email 작성자 이메일NSArray layout 레이아웃NSString link_url 온케이웨더기사링크

⑤ layout (NSArray) 자료구조 : NSString

> 뉴스를 구성하는 글, 이미지, 동영상링크를 순서대로 나열 함.> Separator String : , (콤마)> ex) content_1,환경부와 한국도로공사는....

content_2,이번 협약은 환경부와 한국도로공사가....img_1,http://www.onkweather.com/images/s_logo.jpg

세부구분 설명 비고img_[Index] 이미지링크 [Index]는 순서를 나타

내는 숫자가 입력됨.content_[Index] 본문embed_[Index] 동영상링크

Page 21: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 19 -

⑥ 지수단계

구 분 카 테 고 리 명

commu1 웨더 Inside

eco1 녹색환경 > 환경/에너지

economy1 날씨경영

opinion2 Opinion > 사람들

report2 기후변화

weather1 기상뉴스 > 캐스터리포트

weatherToday 기상뉴스 > 날씨브리핑

headline 뉴스 헤드라인

many_view 많이 본 뉴스

Page 22: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 20 -

3.4 날씨방송

⑴ 날씨영상 ① API 호출 메소드

Method Name

- (KweatherOpenApiRequestFlag)get_mov_vod_VodType:(NSString *)vodType withTimeout:(CGFloat)timeout

Element Description

vodType 카테고리타입명

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnMov_VodDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성NSString listcnt 검색 갯수 9NSString url 영상 상위 URL http 포함한 URL

NSString[요청 카테고리

명]_[Index]_vod영상 파일명 영상 파일명

listcnt갯수만큼 Index증가

반복!

Page 23: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 21 -

⑵ 방송 썸네일 및 정보리스트 ① API 호출 메소드

Method Name- (KweatherOpenApiRequestFlag)get_mov_contents_VodType:(NSString *)vodType withTimeout:(CGFloat)tim

eoutElement Description

vodType 카테고리타입명

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnMov_ContentsDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString region_id 지역코드 5자리의 숫자로 구성NSString listcnt 검색 갯수 9NSString url 영상 상위 URL http 포함한 URL

NSString[요청 카테고리

명]_[Index]_title 방송제목

listcnt갯수만큼 Index증가

반복!

NSString

[요청 카테고리

]_[Index]_contents

방송대본listcnt갯수만큼 Index증가

반복!

NSString[요청 카테고리

명]_[Index]_img썸네일 파일명

listcnt갯수만큼 Index증가

반복!

Page 24: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 22 -

3.5 현위치검색 ① API 호출 메소드

Method Name- (KweatherOpenApiRequestFlag)get_lonlat_Longitude:(NSString *)longitude withLatitude:(NSString *)latitud

e withTimeout:(CGFloat)timeoutElement Description

longitude 경도

latitude 위도

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnLonlatDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString srch_cnt 검색 결과 개수NSArray search_pt 검색지역    

④ search_pt (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString region_id 지역코드 5자리의 숫자로 구성NSString country_ko 국가 이름(한글)  NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)  NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)  NSString city_en 도시 이름(영문)NSString dong_ko 동 이름(한글)  NSString dong_en 동 이름(영문)NSString lon 경도  NSString lat 위도  NSString distance 좌표와의 거리

입력좌표와 region 좌표와의

직선거리(단위: meter)

Page 25: [20131001]iOS Kweather OpenApi Library Guideapi.kweather.co.kr/API_Library/KOpenApi_Guide_iOS.pdf · 2013-10-07 · version 1.0.0 iOS Kweather OpenApi Library Guide iOS Kweather OpenApi

version 1.0.0

iOS Kweather OpenApi Library Guide

iOS Kweather OpenApi Library Guide

- 23 -

3.6 도시명검색 ① API 호출 메소드

Method Name- (KweatherOpenApiRequestFlag)get_city_string_AreaName:(NSString *)areaName withTimeout:(CGFloat)tim

eoutElement Description

areaName 도시명

timeout HTTP Request Timeout

② 데이터 리턴 메소드 (Delegate)

Method Name

- (void)didReturnCity_StringDictionary:(NSDictionary *)dictData

③ dictData 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString result 데이터 검색 성공/실패

0 - 실패

1 - 성공

2 - 호출횟수 초과

3 - 유효기간 만료

4 - Client Key 오류

1 (성공)을 제외한 값에는

다른 요소 값이 표현되지

않음.

NSString srch_cnt 검색 결과 개수NSArray search_pt 검색지역    

④ search_pt (NSArray) 자료구조 : NSDictionary

Object

TypeKey Name 설 명 표 시 형 식 표 출 형 태

NSString region_id 지역코드 5자리의 숫자로 구성NSString country_ko 국가 이름(한글)  NSString country_en 국가 이름(영문)NSString state_ko 광역도 이름(한글)  NSString state_en 광역도 이름(영문)NSString city_ko 도시 이름(한글)  NSString city_en 도시 이름(영문)NSString dong_ko 동 이름(한글)  NSString dong_en 동 이름(영문)