Uberall APIの使い方 - 最初のステップ
基本的な呼び出しとエンドポイントを使用して Uberall API を使用する方法を学びます
この記事では、Uberall API に慣れ、その背後にあるロジックを理解し、最初の API 呼び出しを行うために必要なすべてのことを説明します。
APIとは何ですか?
アプリケーション・プログラミング・インターフェース（API）は、複数のソフトウェア仲介者間の相互作用を定義するコンピューティング・インターフェースです。APIは、実行可能な呼び出しやリクエストの種類、それらの実行方法、使用すべきデータ形式、従うべき規則などを定義します。
UberallはREST API（ RE presentational state transferの略）を使用しています。詳細はこちらをご覧ください。
API 呼び出し (Uberall API に関連)
GET - データ/情報を取得するためだけに使用します。いかなる変更も行いません。
POST - 場所、ビジネス、コンテンツリストなどの新しい従属リソースを作成します
PUT - 既存のリソースを完全に更新する（作成しない）
PATCH - リソースの部分的な更新。ご覧の通り、PUTリクエストはリソースエンティティも変更するため、より分かりやすくなっています。PATCHメソッドは既存のリソースを部分的に更新する場合に適切な選択肢であり、PUTメソッドはリソース全体を置き換える場合にのみ使用してください。
DELETE - リソースを削除する
APIキー
uberall API は、アプリケーションを識別するために 2 つの API キーを使用します。
- 秘密鍵 - サーバー間の通信に使用される
- 秘密鍵は電子メールで共有しないでください
- publicKey - クライアントのブラウザからのAPI呼び出しに使用されます。権限が制限されており、ステータスチェックにのみ使用できます。
API キーはクライアントごとに固有であり、クライアントごとにプライベートキーとパブリックキーが 1 つずつあります。
注意:セキュリティ上の理由により、サンドボックス環境と本番環境では API キーが異なります。
API キーは、アプリケーション内の左下の設定セクションにあります。
関連するAPI呼び出しURL
ベースURL
- https://uberall.com/api/ - ライブ システムのベース URL
- https://sandbox.uberall.com/api/ - サンドボックス環境のベース URL (テスト目的)
エンドポイント
- 場所 - https://uberall.com/api/locations
- ビジネス - https://uberall.com/api/businesses
- データポイント - https://uberall.com/api/datapoints
- ユーザー - https://uberall.com/api/users
例
場所を取得するにはどうすればいいですか?
ロケーションIDによるGET呼び出し
- https://uberall.com/api/locations/123456
- ユーザーは、すべての位置データ、リストとそのステータス、その他の情報を含む API レスポンスを受け取ります。
ロケーション識別子によるGET呼び出し
- https://uberall.com/api/locations/?identifier=Fahrschule01
- ユーザーは、すべての位置データ、リストとそのステータス、その他の情報を含む API レスポンスを受け取ります。
- GET呼び出しは、位置情報の識別子を使用する唯一の呼び出しです。
POST 経由で場所を作成する方法は?
POST呼び出し
- https://uberall.com/api/locations
- ユーザーは、場所を作成するために必要なデータ フィールドのパラメータを定義する必要があります (必須フィールド)
- ユーザーがエラー応答を受信するか、成功を受信するか
- エラー - 何が問題だったかを示す情報が提供されます
- 成功 - 場所が作成されました = 応答内の場所ID
PATCH 経由で位置データを変更するにはどうすればいいですか?
ロケーションIDによるPATCH呼び出し
- https://uberall.com/api/locations/123456
- ユーザーは、場所を作成するために必要なデータ フィールドのパラメータを定義する必要があります (必須フィールド)
- ユーザーがエラー応答を受信するか、成功を受信するか
- エラー - 何が問題だったかを示す情報が提供されます
- 成功 - 位置データが変更されました
DELETE を使用して場所を削除するにはどうすればよいでしょうか?
場所IDによる通話の削除
- https://uberall.com/api/locations/123456
- アクティブな場所は削除できません
- 請求イベントのある場所は削除できません
エラー
アクティブな場所の呼び出しを削除
アクティブなロケーションは削除できません。削除できるのは、現在請求イベントが発生していない（新しい月の開始時に非アクティブになっている）非アクティブなロケーションのみです。
JSONのフォーマットの問題
JSON をチェックして、その形式が正しいことを確認してください。Uberall システムはそれを読み取ることができませんでした。
使用されたJSON - 間違いを見つけることができますか
知っておくべき用語
API - アプリケーション プログラミング インターフェース
APIキー- 特定のデータセットへのユーザーアクセスを許可するアクセストークン
API呼び出し- 適切なエンドポイントでAPIを設定した後、リクエストを送信した際に実行されるプロセスです。情報が転送、処理され、フィードバックが返されます。
APIドキュメント- APIを効果的に使用および統合する方法を説明した技術コンテンツ。Uberall APIドキュメントはこちら
APIレスポンス- リクエストへのレスポンス。SUCCESSまたはERRORのいずれかになります。SUCCESSの場合はエンドポイントの現在のデータも返されます。ERRORの場合はエラーの種類に関する情報が返されます。
エンドポイント- API がソフトウェア プログラムに接続するポイント。
オブジェクト モデル- API のエンドポイントによって返されるオブジェクトのリスト。
サンドボックス- テストされていないコード変更や完全な実験を本番環境やリポジトリから分離するテスト環境
JSON （JavaScript Object Notation）は軽量なデータ交換フォーマットです。人間にとって読み書きが容易で、機械にとって解析・生成も容易です。
解析- 使用されている言語でデータを解釈する