DIAq API

※画像をクリックで拡大表示します

DIAq APIとは

DIAqは、クラウドソーシングによる運送者を使用して、小売業者から顧客に同日配送・回収サービスを展開しています。

DIAq APIは、DIAqサービスで配送や回収の依頼を作成および管理する簡単なインターフェイスを提供します。

DIAq APIは、API利用者の負担を軽くするためにRESTの原則に則って設計されています。

イントロダクション

REST

REST APIとは、Webシステムを外部から利用するためのプログラムの呼び出し規約(API)の種類の一つで、RESTと呼ばれる設計原則に従って策定されたものです。

REST APIでは、URL/URIですべてのリソースを一意に識別し、セッション管理や状態管理などを行わず、同じURLに対する呼び出しには常に同じ結果が返されます。

そのためアプリケーションの作成とテストが非常に簡単にできます。

リソースの操作はHTTPメソッドによって指定し、結果はJSONで返されます。また、処理結果はHTTPステータスコードで通知します。

リクエストメソッド

RESTful APIのため、リソースの操作はHTTPメソッドによって指定します。

メソッド 用途
GET リソースの取得
POST リソースの作成
PUT リソースの更新
DELETE リソースの削除

APIの利用方法

アカウント登録されると、2つのAPIキーが提供されます。
①本番環境用
②開発環境用

APIキーは厳重に管理してください。またクライアント側のコードに記述しないでください。

開発環境では、実際のアンカーに依頼が送られることなく、依頼の作成等のAPIの動作テストを行うことが可能です。

配送ステータスは管理画面から変更することが可能です。

認証

APIキーをApi-Keyという値でリクエストヘッダーに渡します。
APIキーなしのリクエストには、401 Unauthorizedレスポンスを返します。

Api-Key:prod_coGaRKvCl5fjor6X8GHU

ジオコーディング

配送・回収見積作成、依頼作成を行う際に、指定されたエンドユーザー住所のジオコーディング行います。
ジオコーディングが行えなかった場合は、エラーとなりデータは作成されません。

ステータス

ステータス 説明 クエリ値
created 配送、回収依頼データが作成され、アンカーが未確定です。 0
assigned アンカーが確定しました。 1
collecting アンカーが集荷場所に向かっています。 2
arrived_origin アンカーが集荷先住所に到着しました。 3
delivering アンカーが配送先に向かっています。 4
arrived_goal アンカーが配送先住所に到着しました。 5
delivered 配送が完了しました。 6
returning 配送中に例外が発生し、荷物を集荷先に戻しています。 7
returned 荷物を集荷先に戻しました。 8
canceled 配送中に例外が発生し、キャンセルされました。 9

Generated by aglio on 11 Apr 2022