文法とスペルチェックのAPIドキュメント

Postmanのためのドキュメント

Postmanやその他のHTTPデバッグプログラムへのAPIドキュメントファイルをダウンロードすることができます。Postmanでは、コレクションのVariablesタブでキーを設定することができます。.

Download TextGears.postman.json

始め方

シンプルで簡単です。APIは、通常のHTTPおよびHTTPSリクエストに対応しています。出力データはJSONで送信されます。すべてのリクエストは、api.textgears.comサーバーで行われます。

世界各地からのアクセスを高速化するために、米国、エストニア、シンガポールの3ヵ国にサーバーを設置しました。api.textgears.comにリクエストを送信する際には、最も近いクラスタを選択します。しかし、応答の遅れを減らすために、あなたから明示的に近くのクラスターにリクエストすることができます。

https://eu.api.textgears.com – Europe
https://us.api.textgears.com – America
https://sg.api.textgears.com – Asia

すべてのAPIエンドポイントは、独立したサーバーのクラスタです。私たちは、それぞれのサーバーについて、99.9%の保守性を保証しています。もしこれが不十分であると思われる場合は、接続エラーが発生した際にクラスタを変更することができます。

                                                    
import textgears from 'textgears-api';

const textgearsApi = textgears('YOUR_KEY', {language: 'en-US'});
textgearsApi.checkGrammar('I is a engineer')
    .then((data) => {
        for (const error of data.errors) {
            console.log('Error: %s. Suggestions: %s', error.bad, error.better.join(', '));
        }
    })
    .catch((err) => {});
                                                    
                                                

Javascript library

他の言語やフレームワークでAPIを操作するためのライブラリを実装した場合、GitHubやGitLabにリンクを送っていただければ、私たちがそちらも公開します。

対応言語

TextGearsは、文章の言語を考慮するだけでなく、方言も考慮して文章を分析します。対応言語の一覧はこちらです： 英語、フランス語、ドイツ語、ポルトガル語、イタリア語、スペイン語、ロシア、アラビア語、日本語、中国語、ギリシャ語

対応している方言（languageパラメータで送信する必要があります）。 en-US, en-GB, en-ZA, en-AU, en-NZ, fr-FR, de-DE, de-AT, de-CH, pt-PT, pt-BR, it-IT, ar-AR, ru-RU, es-ES, ja-JP, zh-CN, el-GR

認証とパラメータの転送

このリクエストは、以下のいずれかの方法で、あなたのキーを他のパラメータと一緒に転送すること承認されます：

• POST parameter key
• GET parameter key

  ?key=YOURKEY

• Json-request

  {
      "key": "YOURKEY",
      // Other params
  }

• HTTP Header

  Authorization: Basic YOURKEY

  YOURKEYがあなたのキーのところ。

エラーコード

エラーの場合、statusパラメータはfalseの値を持ちます。

{
    status : false,
    error_code : 600,  // API error code
    description : "Invalid license key. Go to https://textgears.com/signup.php to get one"
}

• 600 - 無効なキー
• 606 - 対応していない言語
• 607 - 許可されたリクエスト数を超えました
• 500 - 不明な内部サービスエラー
• 501 - 文章の長さがレート上限を超えました
。