BellaDati uses the OAuth protocol to ensure only authorized users may access the API. Nevertheless, some selected methods are public and could be accessed without authorization. The description of these methods will contain detailed information.

Authentication

OAuth uses a three-step handshake to authenticate users to the system. If a 3rd-party client application is accessing the API on the user's behalf, the OAuth protocol allows users to log in directly with Belladati without having to trust the client application with their credentials.

1. Client application gets a request token from BellaDati.
2. User authorizes the request token with BellaDati using their web browser.
3. Client application exchanges authorized request token for an access token.

Authorization

When a client application is making a request to the BellaDati API, it needs to prove that it has been authorized by a valid user. To do this, it includes the access token received during the authentication process in every API request. BellaDati verifies the token's validity before returning any data to the client application.

Request Integrity

When writing data to the API, client applications may want to ensure their API requests reach the server in the exact way they were issued, e.g. because the client is running in an untrusted network environment. To prevent tampering, the client can attach an OAuth signature to their request, allowing the server to verify that the content of the message hasn't been modified.

OAuth 2.0

Since BellaDati 2.9.18, the OAuth 2.0 protocol is supported. For more details, see here .

Next Steps

BellaDatiはOAuthプロトコルを使用して、許可されたユーザーのみがAPIにアクセスできるようにします。それにもかかわらず、一部の選択されたメソッドは公開されており、許可なくアクセスされる可能性があります。これらのメソッドの説明には、詳細情報が含まれます。

認証

OAuthは、3段階のハンドシェイクを使用して、システムに対してユーザーを認証します。サードパーティのクライアントアプリケーションがユーザーに代わってAPIにアクセスしている場合、OAuthプロトコルを使用すると、ユーザーはクライアントアプリケーションを自分の資格情報で信頼しなくても、Belladatiに直接ログインできます。

1. クライアントアプリケーションは、BellaDatiからリクエストトークンを取得します。
2. ユーザーは、Webブラウザを使用してBellaDatiでリクエストトークンを承認します。
3. クライアントアプリケーションは、承認されたリクエストトークンをアクセストークンと交換します。

認証

クライアントアプリケーションがBellaDati APIにリクエストを送信するときは、有効なユーザーによって承認されていることを証明する必要があります。これを行うために、認証プロセス中に受信したアクセストークンがすべてのAPIリクエストに含まれます。 BellaDatiは、クライアントアプリケーションにデータを返す前に、トークンの有効性を確認します。

整合性リクエスト

APIにデータを書き込む場合、クライアントアプリケーションは、APIリクエストが発行された通りの方法でサーバーに到達するようにしたい場合があります。クライアントが信頼できないネットワーク環境で実行されているためです。改ざんを防ぐために、クライアントはリクエストにOAuth署名を添付して、サーバーがメッセージのコンテンツが変更されていないことを確認できるようにすることができます。

OAuth 2.0

BellaDati 2.9.18以降、OAuth 2.0プロトコルがサポートされています。詳細については、OAuth 2.0をご覧ください。

次に