RESTAPIは、他のアプリケーションが直接にBellaDatiによって提供されたデータにアクセスすることを可能にし、モバイルビジネスインテリジェンスBellaDati Mobileの基礎となるインタフェースです。 APIを介して、ユーザーが独自のカスタム・クライアント・アプリケーションと統合するためレポート、チャート、全体のダッシュボードを取得できる。 
一般的な注意事項Enable REST APIAPIを有効にするAPIにアクセスする前に、あなたのドメインの設定でそれを有効にする必要がある。 - ドメインの設定ページを開く。このページに到達するには、右上にある自分の名前の上にマウスを移動し、ドメインのリンクをクリックしてください。
- OAuth Settings の下の、Configure をクリックする
- Consumer Key とConsumer Secret を入力する。今のところ、他の設定を無視することができる。
Base URLベースURLREST APIにアクセスするためのベースアドレスはhttps://service.belladati.com/api/です。 オンプレミス展開を使用している場合は、https://your-server/belladati/api/になる。 SSLのみBellaDatiクラウドサービスへのすべてのAPIリクエストは、SSL経由で送信する必要がある。 オンプレミス展開では、必須ではないが、強くセキュリティ上の理由のためにSSLを使用することをお勧める。 UTF-8エンコーディングBellaDati REST APIへのすべての文字列はUTF8でエンコードする必要がある。最大の互換性のために、UTF-8エンコーディングの前にUnicodeのUnicode C 正規化（NFC）に正規化する。 ロケールBellDatiRESTAPIは、コンテンツレスポンスの言語設定を指定するためロケールパラメータを使用している。あなたが英語以外の言語でデータを取得したい場合は、適切なIETF言語タグを挿入する。サポートされている言語が指定されている場合、BellaDatiは、コンテンツを翻訳返される。 レスポンス形式APIは、API呼び出しへのレスポンスのためのJSON形式を使用している。また、いくつかのレスポンスが映像のためにHTMLとPNG形式を返すことができる。 | Anchor |
|---|
| httperrorhandling |
|---|
| httperrorhandling |
|---|
|
エラー処理エラーは、標準HTTPエラーコードの構文を使用して返される。任意の追加情報は、JSON形式で復帰コールの本体に含まれている。ここに記載されていないエラー・コードは、それぞれのREST APIメソッドに記述されている。 標準API HTTPエラーは コード | 説明 |
|---|
400 | 不正なインポートパラメータ。その理由を見つけるためにエラー・メッセージを参照してください。 | 401 | 不良または有効期限が切れたトークン。これは、アクセストークンの有効期限が切れているかそうでなければ無効でいる場合に発生する可能です。この問題を解決するには、ユーザーを再認証してください。 | 403 | 悪いOAuthリクエスト（間違ったコンシューマキー、悪いナンス、期限切れのタイムスタンプなど）。詳細については、エラー・メッセージを参照してください。 | 404 | ファイルまたはフォルダが指定されたパスに見つからない。あなたがアクセスしようとしているURLが正しいか確認してください。 | 405 | 予期しないリクエストメソッド。リクエストメソッドは作るしようとしているの要求に応じてGETするかPOSTになる。 | 503 | アプリは、あまりにも多くの要求をしていると速度が制限されている。 503sは、アプリまたはユーザーごとにトリガすることができる。 | 5xx | サーバーエラー。詳細については、エラー・メッセージを参照してください。 |
アプリケーションのランタイムエラーは、次のとおりです。 コード | 説明 |
|---|
request_token_unauthorized | 渡されたリクエストトークンが不正となっており、使用できない。新しいリクエストトークンを作成する。 | request_token_rejected | リクエストトークンが検証に合格しませんでした。それは間違った形式または破損していてもよいです。 | access_token_already_issued | アクセストークンは、すでに渡されたリクエストトークンのために発行された。 | invalid_consumer | コンシューマキーが見つからないまたは要求に存在していませんでした。ドメインの設定とログファイルを確認してください。 | request_token_not_found | リクエスト・トークンが存在しないまたはアクセストークンのためにそれを交換しようとしたときには見られない。 | token_not_found | アクセストークンは、存在していないまたは要求には見られない。これは、要求の整合性とコンシューマキーのような他の前提条件がfullfiledされていることと意味です。 | token_unauthorized | 渡されたアクセストークンは、不正となっており、使用できない。新しいリクエストトークンを作成する。 | parameter_absent | 必須パラメータは、リクエストには存在しない。 | user_not_found | xAuth リクエスト(x_auth_username)でユーザーパスが見つかりませんでした。 | too_many_login_failures | ユーザ/パスワードの組み合わせのためにxAuthを使用している時にあまりにも多くのログイン失敗がある | user_login_failed | xAuthを使用しているユーザー/パスワードの組み合わせが有効ではない。 | user_not_active | xAuthを使用しながら、パスしたユーザーがアクティブではない。 | user_expired | xAuthを使用しながら、パスしたユーザーアカウントがアクティブではない。 | no_domain | ユーザーは、ドメインに関連付けられていない | domain_expired | xAuthを使用しているユーザーのドメインの有効期限が切れている。 | api_disabled | REST APIは、ライセンスキーで有効になっていない。 |
次のステップ |