문서 섹션
빠른 시작
키를 받고, 엔드포인트를 호출하고, 결과를 사용하는 세 단계입니다. 이 설명 옆의 호출은 링크 버짓 계산이지만, 모든 계산기가 같은 방식으로 동작합니다.
세 단계
- API 키를 받습니다. 대시보드에서 받는 무료 키로 월 5회 호출할 수 있습니다. Pro(월 $9)는 100회, API(월 $19)는 10,000회입니다. 요금을 참고하세요. 프로그램은 사용자가 붙여 넣지 않아도 키를 받을 수 있습니다. 디바이스 권한 부여를 참고하세요.
- 엔드포인트를 호출합니다.
/api/py/v1/calculate에slug와 그inputs를 POST로 보내고, 키는X-API-Key헤더에 넣습니다. - 결과를 사용합니다.
values를 출력 이름으로 읽고,warnings와errors를 확인하고, 값의 계산 방법을 밝혀야 한다면provenance를 보관합니다.
키를 코드에 넣지 마세요
예제는 키를 RFTOOLS_API_KEY에서 읽습니다. Python 라이브러리는 rftools login이 저장한 키도 읽으므로, 스크립트에 키를 넣을 필요가 없습니다.
Shell
export RFTOOLS_API_KEY=rfc_…
# or, with the Python library installed:
rftools login입력과 단위
각 계산기는 페이지에 표시된 단위로, 레퍼런스에 나온 키 이름으로 입력을 받으며, 범위와 기본값도 레퍼런스에 나와 있습니다. 모든 입력을 보내세요. 대부분 필수이며, 하나라도 빠진 호출은 거부되고(400) 비용이 들지 않습니다. 생략해도 계산할 수 있는 입력은 레퍼런스에 표시된 기본값을 사용합니다. 출처 정보에는 값을 계산하는 데 쓴 모든 입력이 기록됩니다.
다음
- 키를 사용해 브라우저에서 요청을 시험해 보세요.
- 오류: 각 상태의 의미와 SDK가 발생시키는 예외.
- 할당량과 제한: 월간 할당량과 분당 제한.