API 등록 가이드

승인된 사용자가 API를 등록하고 관리자 승인 후 공개 검색에 노출되기까지의 절차와 샘플 입력 데이터입니다.

STEP 1

회원 승인

회원가입 후 관리자가 승인해야 대시보드 접근과 API 등록이 가능합니다.

STEP 2

필수 항목을 입력하고 임시 저장 또는 검토 요청을 선택합니다.

STEP 3

관리자가 API를 승인하면 /apis 공개 검색과 상세 페이지에 노출됩니다.

항목	작성 방법
API 이름	검색 결과와 상세 페이지의 제목으로 노출됩니다.
카테고리	결제, 지도, 번역, 문서, 메시징처럼 API의 주제를 한 단어 또는 짧은 문구로 입력합니다.
태그	AI와 개발자가 검색할 키워드를 쉼표로 구분해 입력합니다.
한 줄 설명	검색 결과 카드에 노출되는 짧은 설명입니다.
상세 설명	API가 해결하는 문제, 주요 기능, 사용 상황을 자연어로 자세히 작성합니다.
OpenAPI/Swagger 문서 URL	AI 크롤러와 개발자가 API 스펙을 직접 읽을 수 있는 URL입니다.
공식 문서 URL	가이드, 인증, 요금제, 오류 코드 등을 확인할 수 있는 문서 URL입니다.
인증 방식	API Key, OAuth 2.0, Bearer Token 등 실제 인증 방식을 입력합니다.
사용 예시 질문	AI 에이전트가 이 API를 언제 사용해야 하는지 알 수 있는 자연어 질문 예시입니다.
제공 회사명	API를 제공하는 회사 또는 서비스명을 입력합니다.
입력/출력 설명	요청 파라미터와 응답 구조를 사람이 읽기 좋은 문장으로 작성합니다.

아래 값은 `/dashboard/apis/new` 등록 폼에 그대로 입력해 테스트할 수 있는 예시입니다.

name: WeatherPilot Forecast API
category: 날씨
tags: weather, forecast, climate, location
shortDescription: 위치 기반 현재 날씨와 시간대별 예보를 제공하는 API입니다.
detailedDescription: WeatherPilot Forecast API는 도시명, 좌표, 우편번호를 기반으로 현재 날씨, 시간대별 예보, 일별 예보, 강수 확률, 체감 온도, 풍속 정보를 제공합니다. 여행, 물류, 현장 운영, 커머스 배송 안내, AI 일정 추천 서비스에서 날씨 데이터를 활용할 때 적합합니다.
openApiUrl: https://docs.weatherpilot.example.com/openapi.json
documentationUrl: https://docs.weatherpilot.example.com
authType: API Key
exampleQuestions: 서울 강남구의 내일 오전 날씨를 알려줘. 배송 예정 지역에 비가 올 가능성이 있는지 확인해줘. 이번 주말 제주도 여행 일정에 맞춰 날씨를 요약해줘.
providerCompany: WeatherPilot Labs
inputDescription: location 또는 latitude/longitude를 필수로 전달합니다. units, language, forecastRange, includeAlerts 값을 선택적으로 사용할 수 있습니다.
outputDescription: 현재 날씨 객체, 시간대별 예보 배열, 일별 예보 배열, 기상 특보 목록, 요청 위치의 정규화된 주소 정보를 JSON으로 반환합니다.