開発者向けリソース

私たちの予約システムに直接あなたの訪問者を送信するためにあなたのウェブサイトやブログ上の検索ウィジェットを追加します。

検索ウィジェットは、あなたのページにスムーズにマージして、あなたの訪問者の認識を容易にし、中立的な、標準化された外観を持つように開発されました。

最良の結果を得るには、サイドバーに、ページの上部に検索ウィジェットを適用します。

あなたのウェブサイトは、プラットフォームに基づいている場合WordPress.org 私たちは、簡単に組み込みの検索ウィジェットのプラグインを作成しました。

それをインストールすることにより、それをダウンロードプラグインのページ上のWordPress.org ;または - 管理インターフェースを経由して - "プラグイン" /メニューの「新規追加」と「pousadinhas」を探しクリックしてください。 「プラグインを選択してくださいPousadinhas Search Widget "!

あなたのウェブサイトは、プラットフォームに基づいている場合Joomla! 私たちは、簡単に組み込みの検索ウィジェットのプラグインを作成しました。

それをインストールするには、 ここからダウンロードそして - 管理インターフェースを通して - インストールを続行する "拡張"メニュー/「インストール/アンインストール」をクリックしてください。 詳細については、ご覧くださいプラグインのページ拡張ディレクトリJoomla.org 。

ウィンドウの端に結合させることなく、IE - - あなたが "その場で"それを使用する場合は以下を追加します。 {pousadinhas}所望のコンテンツ。


a) 設定

以下では、ウィジェットの検索とプレビュー右ペインに結果を設定するには、左側にあるフォームを使う。

オプションウィジェットプレビュー
処理中...
ウィジェットを使用して行う検索の保存先を選択します。?
チェックを外して日付フィールドを持っている場合は、このオプションは、デフォルト値で初期化されません。?
あなたのページの言語を選択します。?
ウィジェットをドッキングしたい画面の隅を選択します。?
スペースの制約があなたのページのレイアウトの中にある場合は、このオプションをチェックします。?
あなたのページがセキュリティで保護されている場合(httpsプロトコル)このオプションを選択する必要があります。?

b) 実装

手順1. 以下のコードは、単にタグの上、あなたのページに挿入されるべきである</HEAD>ヘッダを閉じる。

手順2.ウィジェットは検索を表示させたい場所を正確に以下のコードは、あなたのページに挿入されるべきである。

1. アプリケーション登録

使用するにはPousadinhas APIそれは、クライアント·アプリケーションは、当社のプラットフォームに登録されていることが必要である。 電子メールでお問い合わせくださいrecursos@pousadinhas.com.brそして、あなたが使用する特徴を示す、名前と開発したいアプリケーションや統合の詳細な説明を提供します。

2. 開発と承認

アプリケーションの登録要求を承認することにより、我々は、我々のテスト環境であなたのアカウントを作成し、expediremosは、開発で使用するための資格情報にアクセスします。

私たちのチームがテストを行うことができるように開発を完了し、それは、アプリケーションにアクセスするための命令を提供する、再度ご連絡することが必要である。 唯一のアプリケーションの承認後、expediremosは本番環境への資格情報にアクセスします。

3. アクセスログイン情報

当社のプラットフォームでのクライアント·アプリケーションのアクセス資格情報は、二つの情報で構成されています。

  • client_id - クライアントアプリケーション識別子、公共。
  • client_secret - クライアント·アプリケーションの秘密、プライベート。

アクセスログイン情報に直接アクセスするために使用することはできませんPousadinhas API 。 しかし、彼らは(アクセストークンを得るために必要であるaccess_token )、API認証メカニズムを使って;このトークンは、APIへのアクセスに使用される。

クライアントアプリケーションは維持しなければなりませんclient_secret絶対秘密で、任意の疑いのある妥協があるたびに同じの返還を要求しなければならない。

信頼できないデバイス(例えばモバイルアプリケーション)上で展開されるアプリケーションの場合には、 client_secret影格納する必要があります。 また、クライアント·アプリケーションはエラー交換の指示があるたびに更新が適用された実行を促すべきであるclient_secret

4. データの暗号化

認証メカニズムとAPIの両方で送受信されたすべての要求と応答は、UTF-8エンコーディングを使用します。

5. 認証機構

認証機構Pousadinhas API標準に基づいているOAuthの2.0 。 APIへのすべてのアクセスは(アクセス·トークンを使用して行われなければならないaccess_token )以前はこのメカニズムによって得られた。

アクセストークンを取得し、更新のルーチンは次のURLにPOST型のリクエストを介して行われます。

https://www.pousadinhas.com.br/oauth2/token?idioma=ja

アプリケーションの資格情報は、基本的な認証URLを通じて、またはPOST変数を介してこれらの要求を知らされるべきであるclient_idclient_secret

助成金の種類( grant_type )認証メカニズムによってサポートされているOAuthの2.0実装されています: client_credentialspasswordrefresh_token 。 説明書を参照してくださいOAuthの2.0助成金の種類ごとに追加のパラメータのために。

成功した認証機構は、(アクセス·トークンを含む、JSON形式でコード200と結果を返すaccess_token )、その有効性( expires_in )アクセススコープ( scope )と(トークン交換をオプションrefresh_token )。

エラーの場合、認証機構は、コードを含む、400のコードとJSON形式で結果を返しますOAuthの2.0エラー( error )と英語で、より詳細なエラーの説明( error_description )。

アクセストークンの取得

アクセストークンを取得するには助成金のタイプを使用してURL認証にPOSTリクエストを提出することが義務付けられているclient_credentialsまたはpassword

助成金の種類別client_credentialsあなたは公開データのプラットフォームへのアクセストークンを取得することができます。

助成金の種類別passwordあなたがアクセス資格情報の要求で提供された公開データとユーザデータプラットフォームへのアクセストークンを取得することができます。

与える場合にはpasswordアクセストークンに加えて、(トークン更新を返されるrefresh_token )アプリケーションによって格納され、使用中のアクセストークンの有効期限が切れるように、新しいアクセストークンを取得するために使用することにする。

アプリケーションが認証されたユーザーに代わって要求を行っている場合、それは付与して得られたアクセストークンを使用する必要がありますpassword 。 これは、アクセスされたデータは、グラントの種類によって得られるトークンからも得ることができる場合にも観察されるべきであるclient_credentials

いかなる場合も、アプリケーションは、永続的にユーザーによって提供されたアクセス認証情報を格納する必要があります。 アプリケーションは、ユーザーが提供する資格情報が認証した直後に破棄され、ログに誤って含まれているか、またはデバッグファイルに準拠していないことを確認する必要があります。

助成金の種類password唯一の彼らのアクセスの資格情報を提供するために、ユーザーが必要とする信頼の高い特定のパートナー·アプリケーション·プラットフォームのクライアントに放出される。

アクセストークンの更新

有効期限が切れたトークンを置き換える新しいアクセストークン、では、助成金の種類を使用してURL認証にPOSTリクエストを送信する必要がありますrefresh_token

新しいアクセストークンを取得するには、トークン古い改装工事を廃止され、発行された新しい更新トークンで交換する必要があります。

すべてのアクセスの前にPousadinhas API 、クライアントアプリケーションは、最初に必要に応じて更新、アクセストークンの有効性を確認する必要があります。 有効期限が切れたトークンの使用は、新しいトークンおよびその後の再試行を求めることにより、処理されるべきAPIコール(コード401)にエラーが発生します。

6. APIの構造

アクセスPousadinhas API次の基本URLを使用して計算される。

https://www.pousadinhas.com.br/api/v2/?idioma=ja

URLベースのAPIアクセスURLの構造は、4段階に分割されたパターンに従う。

  • /collection - オブジェクトのコレクションへのアクセス。
  • /collection/{id} - 識別子によるコレ​​クションオブジェクトへのアクセス。
  • /collection/{id}/property - 識別子とプロパティの名前でコレクション内のオブジェクトのプロパティへのアクセス。
  • /collection/name - コレクション内の1つ以上のオブジェクトに関連する取引へのアクセス。

ザ· Pousadinhas API RESTの原則とHTTPプロトコルアクセスパターンに従う。 次のように、アクセシビリティが構成されています。

  • オブジェクトを読み取るための要求をGET。
  • オブジェクトを記述するためのPUT要求。
  • オブジェクトを作成するためのPOSTリクエスト。
  • オブジェクトの除去のための要求を削除する。

一覧を見るAPIリソース

7. データ形式

ザ· Pousadinhas API使用は、パラメータで構成されている場合(返される型のリクエストを取得するには、JSON形式および必要に応じてJSONPでの作業callback )。

すべての要求は、適切なHTTPコードに加えて、sequintesフィールドを持つJSONオブジェクトを返します。

  • meta - (HTTP戻りコードが含まれていますcode英語で)そして、エラーの場合、エラーの説明( error_detailリクエストで設定された言語上の)とエラーメッセージ( error_messages )エラーに関連付けられているフィールドを示す。
  • data - 要求されたデータが含まれています。
  • caching - (識別キーオブジェクトが含まれていますhashkey )とデータの有効期限( expires_in )クライアント·アプリケーションとの間でトラフィックを最適化するために使用Pousadinhas API GETにし、要求タイプをPUT。

リクエストをPOSTやPUT、彼らは要求の本文にJSON形式で要求内容を提出し、ヘッダの "Content-Type"と "アプリケーション/ JSONを「通知しなければならない。

8. データキャッシング

ザ· Pousadinhas API HTTPプロトコルのネイティブキャッシュメカニズムに触発単純なキャッシュ機構を実装しています。

GETとPUTリクエストでは、パラメータを通知するhashkey (またはヘッダーIf-None-Match )サービスが、結果ハッシュキーと比較し、それが一致しない場合にのみ、それを返します。このように、クライアントアプリケーションにトラフィック情報を保存する。

これらの要求サービスは、フィールドを返すcaching (返されるオブジェクトのハッシュキーを含むhashkey )と有効時間データ( expires_in )。 要求は、ヘッダを用いて作製された場合If-None-Matchこの情報は、ヘッダを介して返送されますEtagポリシーmax-ageヘッダCache-Controlそれぞれ。

そこにハッシュキーとの対応であり、返されるハッシュキーを通知すると、サービスは304コードを返し、フィールドを省略data

データが存在し、フィールドに応じて期限が切れていないときに、クライアント·アプリケーションは、まったく同じパラメータで、同じURL APIに、第二のGETリクエストを送信してはならないexpires_in

9. ページネーション

APIを介してページングデータはURLパラメータを使用してなされるべきであるoffsetlimit 。 パラメーターoffsetページの開始点を設定する。 パラメーターlimitページサイズを設定します。 結果の次のページに移動するには、単に同じアプリケーション要求を提出したが、フィールドの値を大きくするoffsetフィールド値limit

すべてのデータがページ サイズを使用させる*これを任意の大きさのデータを避けなければならないことを指摘しました。

10. 按手

APIリクエストの結果は、UR​​Lパラメータを使用して注文することができますsortby 。 このパラメータは、指定された順序に従って、順番に使用する必要があるフィールドを定義する。 接尾辞の使用は、 " - "の並べ替えが減少するために起こります。

例えば、 sortby=price-,name最高最低に、価格のための入力データの収集を注文し、2つのオブジェクトが同じ価格、オブジェクトの名前を持っている場合します。

11. フィールドフィルタ

パラメータ経由でfieldsあなたがAPIによって返されるフィールドを定義することができます。

これは、返されたオブジェクトだけでなく、任意の深さと、後者が参照するオブジェクトをフィルタリングするためのフィールドだけでなく、定義することが可能である。 また、オブジェクトを構成するコレクションを返すためにオブジェクトの数を設定することができます。 フィールドidオブジェクトの常に返され、指定する必要はありません。

例えば、 fields=name,place{name,photos(10)},photos(10){id}れるフィールドidnameplace.idplace.name 、フィールド10 id運命とインの写真。

すべてのオブジェクトは、コレクションの使用に*これを任意のサイズのコレクションに対する避けなければならないことに注意。

12. シミュレーション実行

スルーPousadinhas API実際にはデータ要求を変更することなく、POST / PUTの実行(ドライラン)をシミュレートすることができ、それは検証エラーを検出することができる。このために、単純にURL変数を指定するdryrun=1リクエストで。

13. 標準パラメータ

ザ· Pousadinhas APIさまざまなAPIサービスに対称的に適用されるいくつかのURLパターンのパラメータを(変数をGET)をサポートしています。

  • access_token - この変数は、認証機構によって得られた有効なアクセストークンが含まれている必要がありOAuthの2.0
  • callback - この変数は、要求の種類を取得するために制限されているJSONP形式の復帰に使用される関数名を指定します。
  • hashkey - 値が返される値と一致した場合、この変数は、データに予想されるハッシュキーが含まれている、データをクライアントに送信されません。
  • fields - この変数は、階層的に戻されるフィールドを示し、返されるデータの構造を記述する。
  • dryrun - この変数は、POST / PUTメソッドにのみ、実際にデータを変更せずに要求をシミュレートする必要があると規定している。テストや提出に先立って、データの検証に便利。
  • sortby - コレクションのフィールドは結果をソートするために使用されるべきであるこの変数指定します。
  • offset - この変数は、ページングの開始点を指定する。
  • limit - この変数は、ページのサイズを指定します。

14. レート要求の制限

虐待を防止するために、 Pousadinhas APIクライアントアプリケーションの事前設定されたクォータ以内になされなければならないAPIへのアクセスの記録を保持。

クォータは、APIサービスによっても異なる場合があります要求し、アクセストークンの種類によって異なります。 GETリクエストのタイプは、POSTタイプは/ PUT / DELETE要求し、より高い寸法を有する。 付与して得られたトークンによるアクセスclient_credentialsクォータの適用を入力し、すべてのインスタンスで共有されている。 トークンによるアクセスを許可することで取得していますpassword同じを使用する他のクライアントアプリケーションによって共有され、ユーザのクォータを入力してください。

クォータのサイズと残りの要求の数は、ヘッダを各APIリクエストのリターンで報告されているX-RateLimit-LimitX-RateLimit-Remainingそれぞれ。

クォータを超えることは、APIは、クライアントアプリケーションコード429に戻り、ヘッダ内になるRetry-After秒数は、アプリケーションが新しい試みを提出する前に待機します。

あなたは、操作の取り消しが可能、クォータの破裂が原因で待っているときに、クライアント·アプリケーションは、ユーザーにタイマーを示さなければならない。 また、クライアント·アプリケーションが、それが認証され見つからない場合は、一時的なクォータ制限を改善するためにログインすることをユーザに示唆することをお勧めします。

レート要求のアプリケーション上の制限は、我々のチームへの要求バイケースで検討することができます。

15. 場所

言語、通貨、タイム ゾーンから電話の面での場所Pousadinhas API次の URL のパラメーター (GET 変数) を使って行う必要があります。

  • language-この変数を示します。 この API によって返されるメッセージで使用する言語
  • currency-この変数を示します。 この API によって返される価格で使用される通貨
  • timezone-この変数を示します。 この API によって返される日付/時刻のエンコーディングで使用するタイム ゾーン

Pousadinhas API常に、要求で使用されるアクセス トークンに関連付けられたユーザー アカウントの設定に関係なく、これらのパラメーターに従ってデータを返します。

16. リターンコード

以下は、リターンAPIによって返された成功またはエラーのためのコードと、それらが発生する状況のリストは、次のとおりです。

  • 200 - 動作を実現することに成功。
  • 201 - 新しいオブジェクトを作成する際に成功。
  • 304 - 動作を実現することに成功するが、通知オブジェクトのハッシュキーが一致し、データが省略された。
  • 400 - 安全ではないHTTPアクセス。必須パラメータまたは変数が報告されていない。追加のパラメータまたは変数が認識されません。無効なパラメータまたは変数。そのようなオブジェクトませんか、または無効JSON。読み取り専用のことができますフィールドアップグレード。予行演習はサポートされていません。
  • 401 - アクセストークンの欠如。トークンが無効ですアクセス、有効期限が切れているか取り消さ。アクセスは、アプリケーションを拒否された。
  • 403 - リクエストを行うための十分な権限。
  • 404 - そこリソース(コレクション、オブジェクトなど);
  • 405 - 購買申請の種類がサポートされていません。
  • 409 - オブジェクトの/更新/削除を作成できませんでした。
  • 429 - クォータのアクセスを超過。

17. コンソールアクセス

に慣れるために、 Pousadinhas API 、訪問APIコンソール Apigeeを搭載。

環境テスト POUSADINHAS.COM.BR架空の環境は完全に自己完結し、本番環境と機能的に同じです。それを通して、あなたは完全に現実から分離で、その動作に影響を与えることなく、当社のプラットフォームのすべての機能をテストすることができます。

あなたが私たちのテスト環境にアクセスする際に興味を持っている場合は、にメールを送ってください recursos@pousadinhas.com.brあなたの要求の理由を識別し、記述する。