API 문서기술 문서

엔드포인트 설명을 바탕으로 한 API 문서

보통 15분 안에 완료수정 포함품질 검수
패키지
안전 결제자세히
  • 패키지 범위 내 수정은 무료입니다.
  • 납품 후 3일 이내에 응답하지 않으면 작업이 자동으로 승인됩니다.

결제 시 금액이 예치되며, 작업을 승인해야만 지급됩니다.

엔드포인트 설명을 바탕으로 한 API 문서

결과물 예시

스탠다드 패키지 예시

API 문서: 온라인 쇼핑몰용 배송 추적 API

빠른 시작

  1. Dashboard → Settings → API keys에서 API 키를 발급받습니다.
  2. 모든 요청에 Authorization: Bearer <your_key> 헤더를 붙여 보냅니다.
  3. 기본 URL: https://api.trackpoint.example/v1

배송 조회

GET /shipments/{tracking_number}

택배 한 건의 현재 상태와 이벤트 기록을 반환합니다.

파라미터위치필수설명
tracking_numberpath예택배사 송장 번호, 8~30자
langquery아니요상태 문구 언어: en, de, fr. 기본값 en

요청 예시

curl https://api.trackpoint.example/v1/shipments/JD014600006281 \
  -H "Authorization: Bearer sk_test_51x..."

응답 예시 (200)

{
  "tracking_number": "JD014600006281",
  "status": "in_transit",
  "estimated_delivery": "2026-11-19",
  "events": [
    {"time": "2026-11-16T08:42:00Z", "location": "Leipzig hub", "status": "in_transit"}
  ]
}

오류

코드의미조치
401API 키가 없거나 잘못됨Authorization 헤더 확인
404송장 번호를 찾을 수 없음택배사가 새 택배를 등록하는 데 최대 2시간이 걸릴 수 있음
429분당 요청 100회 초과Retry-After 헤더에 표시된 시간만큼 대기

전달물

의뢰인 문서 사이트에 바로 올릴 수 있는 엔드포인트 14개 전체의 마크다운 문서와, API가 설명과 다르게 동작한 3곳의 목록(개발팀에 전달 완료).

의뢰인: 온라인 쇼핑몰이 택배 상태를 보여 줄 수 있는 REST API를 제공하는 스타트업 Trackpoint. 개발팀이 엔드포인트 14개의 짧은 설명과 예시 요청 모음을 보내옴 요청 사항: 개발자가 15분 안에 따라 할 수 있는 빠른 시작 가이드와 엔드포인트 레퍼런스. 아래는 일부

고객과 모든 정보는 가상입니다.

서비스 소개

개발자는 몇 분 만에 문서로 API를 판단합니다. 인증이나 첫 요청이 작동하지 않으면 떠나 버립니다. 엔드포인트 설명, OpenAPI 파일 또는 코드 샘플을 바탕으로 API 레퍼런스와 가이드를 작성합니다. 인증, 기본 URL, 파라미터가 포함된 각 엔드포인트, 요청 및 응답 예시, 오류 코드, 요청 한도, 페이지네이션까지 담습니다. 빠른 시작 가이드는 몇 단계 만에 첫 호출을 성공하는 방법을 보여 줍니다.

포함 사항

  • 제공 내용코드 블록이 포함된 Markdown 형식의 API 문서로 드리며, ReadMe, GitBook, Docusaurus 또는 저장소에 바로 사용할 수 있습니다. 보내 주신 자료를 바탕으로 작성하며 API를 직접 호출하지는 않습니다.
  • 빠른 시작API 키 발급부터 첫 호출까지
  • 엔드포인트 레퍼런스파라미터, 타입, 예시
  • 오류와 한도코드, 의미, 재시도 안내
  • 코드 샘플cURL과 선택하신 언어 1가지
  • 일관된 용어스키마와 동일한 이름

진행 방식

  1. 1
    요청 사항엔드포인트와 예시를 붙여 넣거나 첨부해 주세요
  2. 2
    구성과 작성레퍼런스와 가이드를 작성합니다
  3. 3
    납품바로 게시할 수 있는 Markdown을 받으십니다

준비해 주실 내용

텍스트로 붙여 넣은 엔드포인트 설명이나 OpenAPI 또는 Postman 파일, 인증 정보, 요청 및 응답 예시, 오류 코드, API 사용자층을 알려 주세요.

다음 내용을 여쭤봅니다:

  • API는 어떤 기능을 하며, 누가 사용하나요?
  • 인증은 어떻게 이루어지나요?
  • cURL 외에 코드 샘플은 어떤 언어로 작성할까요?
  • 문서는 어디에 게시되나요?

패키지 비교

패키지베이직₩27,400스탠다드₩56,300프리미엄₩114,000
포함 사항빠른 시작과 최대 5개 엔드포인트가이드를 포함한 최대 20개 엔드포인트최대 50개 엔드포인트, 전체 문서
작업 기간1일3일5일
수정 횟수123
분량최대 2,000단어최대 6,000단어최대 14,000단어
엔드포인트 수최대 5개최대 20개최대 50개
코드 샘플 언어cURLcURL + 1cURL + 2
주문하기 베이직주문하기 스탠다드주문하기 프리미엄

안전 결제

주문할 때 결제하지만, 대금은 승인된 작업에 대해서만 지급됩니다.

  • 고정 가격결제 후에는 패키지 가격이 변경되지 않습니다.
  • 금액 예치결제 시 금액은 예치만 됩니다. 작업을 승인하면 서비스에 지급됩니다.
  • 납품 전 검수모든 결과물은 전달되기 전에 품질 검수를 거치며, 승인하기 전에 주문 페이지에서 확인할 수 있습니다.
  • 무료 수정패키지에서 허용하는 횟수만큼 요청 사항 범위 내에서 수정을 요청할 수 있습니다.
  • 3일 후 자동 승인납품 후 3일 이내에 작업을 승인하거나 수정을 요청하지 않으면 자동으로 승인됩니다. 납품 후 주문 채팅에 메시지를 남기면 주문은 대기 상태가 됩니다. 저희가 답변한 뒤 3일을 다시 시작할 수 있으며, 이 경우 채팅으로 알려 드립니다.
  • 재작업 또는 전액 환불결과물이 요청 사항과 맞지 않고 수정으로도 해결되지 않았거나, 작업이 작업 기간의 두 배를 넘겨 지연되면 주문 채팅에 알려 주세요. 작업을 다시 하거나 결제 금액을 전액 환불해 드립니다.
이용 방법 →

질문과 답변

OpenAPI 명세를 바탕으로 작업할 수 있나요?

네, YAML이나 JSON을 요청 사항에 붙여 넣어 주세요. 설명을 읽기 쉬운 레퍼런스 페이지로 바꾸고, 짚어 주신 빈 부분을 채웁니다.

예시도 테스트해 주시나요?

API를 직접 호출하지 않습니다. 예시는 보내 주신 요청 및 응답 샘플로 만들어지므로, 게시 전에 한 번 실행해 보세요.

SDK 문서도 작성해 주시나요?

네, 메서드 시그니처와 사용 예시를 보내 주시면 가능합니다. 각 SDK는 패키지 분량에 포함하여 계산합니다.

답을 찾지 못하셨나요?

패키지