좋은 문서는 한 번 써보고 마는 도구와 지속적으로 도입하는 도구의 차이를 만듭니다.
오늘 FourA 플랫폼의 전체 문서 사이트인 foura.ai/docs를 공개합니다.
포함된 내용
시작하기
가입부터 2분 안에 첫 데이터 수집을 성공하기까지 필요한 모든 내용을 담았습니다. 빠른 시작 가이드, 인증 설정, 그리고 Python, Node.js, Go, Ruby, cURL 예제를 제공합니다.
API 레퍼런스
모든 작업에 대한 request 파라미터, response 형식, 오류 코드, 바로 복사해 사용할 수 있는 코드 예제가 포함된 전체 endpoint 문서입니다.
가이드
FourA 핵심 개념 상세 설명: 사용 사례에 맞는 task 유형 선택 방법, 보호된 사이트 처리, 성능 및 비용 최적화 방법 등을 다룹니다.
사용법 튜토리얼
동적 웹사이트 스크래핑, 경쟁사 가격 모니터링 등 특정 작업을 위한 단계별 가이드이며 매주 추가될 예정입니다.
문제 해결
빈 response와 timeout 오류부터 인증 문제 및 rate limit까지 흔히 발생하는 문제의 해결 방법을 제공합니다.
개발자를 위한 설계
문서 사이트는 개발자 경험을 최우선으로 고려하여 제작되었습니다:
- 전체 문서를 대상으로 하는 전문 검색(Full-text search)
- 주제별로 정리된 사이드바 탐색
- 원하는 위치로 바로 이동할 수 있는 각 페이지의 목차(Table of contents)
- 순차적인 학습을 위한 이전/다음 탐색
- 모든 기기에서 원활하게 작동하는 모바일 친화적 레이아웃
모바일 환경에서도 동일하게 편리하게 이용할 수 있습니다.
향후 계획
문서는 계속 발전하는 프로덕트입니다. 사용자 피드백을 바탕으로 매주 새로운 가이드와 튜토리얼을 추가할 예정입니다. 곧 업데이트될 항목은 다음과 같습니다:
- Python 및 Node.js용 SDK 빠른 시작 가이드
- Webhook 및 콜백 문서
- 고급 proxy 구성 가이드
- 연동 예제 (n8n, Zapier, Make)
피드백 환영
오타를 발견하셨거나 다루었으면 하는 주제가 있다면 support@foura.ai로 알려주세요. 가장 훌륭한 문서는 문서를 작성한 사람이 아니라 실제 사용하는 사람들의 피드백으로 완성됩니다. 언제든 의견을 공유해 주시기 바랍니다.