GothBox

GothBox ヘルプセンター

目次

はじめに

GothBox APIへようこそ！このヘルプセンターでは、四柱推命計算APIの利用方法から技術的な質問まで、様々な情報を提供しています。

【GothBoxをすぐに始めるには】

  • ユーザー登録を行う
  • ダッシュボードからAPIキーを取得する
  • APIドキュメントに従ってリクエストを送信する

APIの利用方法

基本的なAPIリクエスト

エンドポイント:

https://gothbox.com/api/v1/calculate.php

認証方法:

クエリパラメータとしてAPIキーを指定してください：

?api_key=YOUR_API_KEY

必須パラメータ

パラメータ 型 説明
api_key string 認証用APIキー
year integer 西暦（例: 1985）
month integer 月（1〜12）
day integer 日（1〜31）

オプションパラメータ

パラメータ 型 説明
hour integer 時間（0〜23）
minute integer 分（0〜59）
location float 経度（例: 東京の場合 139.69）

リクエスト例

クエリパラメータでのリクエスト例:

https://gothbox.com/api/v1/calculate.php?api_key=YOUR_API_KEY&year=1974&month=10&day=3&location=140.47

cURLを使用:

curl "https://gothbox.com/api/v1/calculate.php?api_key=YOUR_API_KEY&year=1974&month=10&day=3&location=140.47"

JavaScriptを使用:

fetch('https://gothbox.com/api/v1/calculate.php?api_key=YOUR_API_KEY&year=1974&month=10&day=3&location=140.47')
.then(response => response.json())
.then(data => console.log(data));

クレジットシステム

クレジットとは？

クレジットはAPIリクエストを行うために必要なリソースです：

  • 消費量: 1回のAPI呼び出しにつき、10クレジットが消費されます
  • 確認方法: 現在のクレジット残高はダッシュボードで確認できます
  • 購入方法: クレジットは料金プランページから購入できます

クレジット管理のヒント

  • オートチャージ機能: クレジット残高が少なくなった際に自動的にチャージする機能を設定できます
  • 使用量通知: クレジット残高が特定のしきい値を下回った際に通知を受け取ることができます
  • 使用状況分析: ダッシュボードでクレジット使用履歴を確認し、使用パターンを分析できます

よくある質問（FAQ）

Q: アカウントとAPIキー

  • Q: APIキーはどこで確認できますか？
  • A: ログイン後、ダッシュボードで確認できます。
  • Q: APIキーを紛失した場合はどうすればいいですか？
  • A: ダッシュボードから新しいAPIキーを生成できます。ただし、古いキーは無効になりますのでご注意ください。
  • Q: 複数のアプリケーションで別々のAPIキーを使いたい場合は？
  • A: Plusプラン以上では、複数のAPIキーを生成して管理できます。

Q: クレジットと支払い

  • Q: クレジットが不足した場合どうなりますか？
  • A: API呼び出し時にエラーコード 402 (Payment Required) が返され、計算は実行されません。
  • Q: クレジットに有効期限はありますか？
  • A: 購入したクレジットに有効期限はありません。いつでもご利用いただけます。
  • Q: 料金プランを変更できますか？
  • A: はい。いつでも料金プランページから変更可能です。

Q: 技術的な質問

  • Q: どの四柱推命の計算方法を採用していますか？
  • A: 日本の伝統的な四柱推命の計算方法を採用しています。経度パラメータ（location）を追加することで、より正確な地域に基づいた計算が可能です。特に立春などの二十四節気については、国立天文台のデータを元に詳細かつ正確に計算しており、高精度な命式作成を実現しています。
  • Q: レスポンスのフォーマットは？
  • A: すべてのレスポンスはJSON形式で返されます。フォーマットの詳細はAPI仕様書をご確認ください。
  • Q: レスポンスタイムはどのくらいですか？
  • A: 通常、100ms以内に結果を返します。

トラブルシューティング

一般的なエラーコード

コード 意味 対処法
400 Bad Request パラメータを確認してください
401 Unauthorized APIキーを確認してください
402 Payment Required クレジットを追加してください
404 Not Found エンドポイントURLを確認してください
429 Too Many Requests リクエスト頻度を下げてください
500 Server Error お問い合わせください

解決策と対処法

リクエストエラーの場合：

  • パラメータの型と範囲を確認してください
  • 日付と時間が有効な値であることを確認してください
  • 特殊文字やスペースが含まれていないか確認してください

認証エラーの場合：

  • APIキーが正しくコピーされているか確認してください
  • APIキーの有効期限が切れていないか確認してください
  • ヘッダーまたはクエリパラメータの形式が正しいか確認してください

開発リソース

サンプルコード

以下の言語のサンプルコードを提供しています：

  • JavaScript
  • PHP
  • Python
  • Ruby

SDKとライブラリ

公式SDKをご利用いただけます：

  • Node.js SDK
  • PHP SDK
  • Python SDK

WebHookとイベント

特定のイベント発生時に通知を受け取るWebHook機能も提供しています：

  • クレジット残高通知
  • 料金プラン変更通知
  • APIキー更新通知

お問い合わせ

さらなる質問や技術サポートが必要な場合は、以下の方法でお問い合わせください：

Plusプラン以上をご利用のお客様は、優先サポートをご利用いただけます。