APIを公開している事業者向けに、初めて使う開発者が「何を準備し、どう実行し、どんな結果が返るか」を確認できるQuickstartを作成します。
ご指定の1用途について、提供いただいた仕様とテスト環境を確認し、実際に動かした手順をMarkdown文書と小さなサンプルコードにまとめます。認証方法、リクエスト、期待結果、代表的なエラー時の確認点を含めます。
【基本料金に含むもの】
・1 API、1利用場面、1言語、主要1エンドポイントと必要な認証処理
・Quickstart本文(Markdown)と実行可能な最小サンプルコード
・実行手順、期待結果、代表的な失敗時の確認点
・実際に確認した環境と結果の記録
・合意した範囲の軽微な修正1回
【進め方】
1. 購入前にAPI資料、対象の利用場面、試用条件を確認して制作範囲を決めます。
2. テスト用のアクセスと架空・匿名のサンプルデータで実行し、文書とコードを作成します。
3. 再実行で結果を確認し、Markdownとコード、確認記録を納品します。
【対象外】API本体・SDK全体の開発、本番環境への組み込み、公開サイトへの反映、長期保守、複雑な認可フローやWebhookを含む制作。複数の利用場面や言語が必要な場合は、購入前に個別にお見積もりします。
資料やテスト環境に不足があり、実行結果を確認できない場合は、確認できた範囲と残る不明点をお伝えして進め方を相談します。利用者数や売上などの成果は保証しません。生成AIを制作補助に使いますが、納品する手順とコードは実際に確認した範囲を明記します。
購入前に、①APIの公式資料、②初回利用者に試してほしい1用途、③テスト環境と利用条件、④希望言語、⑤成果物の公開・再利用可否をココナラ内のメッセージでお知らせください。範囲と納期を確認してからご案内します。
本番用APIキー、パスワード、認証コード、実在顧客の個人情報は送らないでください。認証が必要な場合は、権限と期限を限定したテスト専用キーの共有方法を購入前に相談します。キーはコードや納品文書に記載しません。納品後は失効をお願いします。
第三者のAPIや資料を対象にする場合は、利用・改変・納品に必要な権限をご確認ください。APIの利用料や有料環境が必要な場合は着手前に確認します。仕様不明や環境障害で作業範囲が変わる場合は、追加作業の前に相談します。