NamePile

NamePile APIドキュメント

/detectInfo

/detectInfo は、名刺・署名・自由形式テキストなどの文字列を解析し、含まれている個人名・企業名・連絡先情報を構造化されたJSONとして返します。

エンドポイント

                        POST /detectInfo
                        Content-Type: application/json
                        

リクエストボディ

text には、名刺やメール署名、OCR結果などの自由形式テキストを指定します。
改行を含む文字列や、日本語・英語が混在したテキストにも対応しています。

                        {
                            "text": "解析対象の文字列"
                        }
                        

レスポンス例

                        {
                            "name": "山田 太郎",
                            "company_name": "株式会社サンプル",
                            "email": "t.yamada@example.com",
                            "company_tel": "03-1234-5678",
                            "mobile_tel": "090-1234-5678",
                            "postal": "100-0001",
                            "address": "東京都千代田区千代田1-1",
                            "website": "https://example.com"
                        }
                        
フィールド名説明
name string / null 検出された個人名
company_namestring / null検出された企業名
emailstring / nullメールアドレス
company_telstring / null固定電話番号
mobile_telstring / null携帯電話番号
postalstring / null郵便番号
addressstring / null住所
websitestring / null WebサイトURL

使用上の注意点

  • 複数候補が存在する場合、最も信頼度が高いものを返します。
  • すべての項目が必ず検出されるわけではありません。
  • 解析結果は入力テキストの内容に依存します。

使用例

                        curl -X POST https://namepile.site/detectInfo \
                            -H "Content-Type: application/json" \
                            -d '{
                                "text": "株式会社サンプル\n山田 太郎\nt.yamada@example.com\n090-1234-5678"
                        }'
                        

/ping

/ping は、クライアントからのリクエストに対してAPIが応答可能な状態であることを確認するためのエンドポイントです。

エンドポイント

                        GET /ping
                        

レスポンス例

                        {"status": "ok"}
                        

使用例

                        curl https://namepile.site/ping