Ship&co APIのご利用

Ship&co APIは、RESTの原則に基づいて設計されたAPIです。料金プランを問わず、どのShip&coユーザーでもご利用いただけます。

当社のREST APIには、送り状作成機能、送料確認機能、追跡機能など含まれています。既に独自の管理システムをお持ちのEC関連企業様や倉庫業者様には、Ship&co APIをご利用いただく事で、Ship&coの管理画面にアクセスする必要がなく、既存のシステムにShip&coの機能を組み込んでご利用いただけます。ホームページでは、Ship&coのAPI仕様書を公開しています。詳細はこちら。

Ship&co APIを設定する

Ship&co APIを使用するには、次の手順をお進みください。

1. Ship&coアカウントを作成
   APIご利用には、Ship&coのアカウント登録が必要となります。アカウント登録はこちら。
2. Ship&coの管理画面でAPIトークンを取得（認可）
   Ship&co設定画面にて作成できる「APIトークン」を取得し、HTTPヘッダーに設定することで、アカウントを認証し、APIを使用できるようになります。
   これらの手順が完了すると、出荷情報を入力し、出荷先住所、貨物内容、商品情報、運送会社契約、荷受人住所に基づいて送り状を作成できます。出荷に関する詳細はガイドをご参考ください。
   ご注意：1つのShip&coユーザーアカウントにつき1つのAPIトークンしか取得できません。APIトークンを更新した場合は、以前のトークンは無効となりそれを使ったAPIの呼び出しもエラーとなりますのでご注意ください。
3. APIコール/APIコールのテストを実施
   API仕様書とサンプルコードを利用し、簡単にAPIコールを実施できます。

Ship&co APIを使用する前に、次の詳細を必ず確認してください

• Ship&co APIは、複数の運送会社システムと連携しています。出荷を作成するAPIコースを実施する際、正確な発送元と荷受人住所が必要です。テストの場合でも、有効な住所情報をご利用ください。
• APIの利用料金は、Ship&coアプリユーザーと同じ料金です。Ship&co料金について詳細はこちら。
• 登録した後、最初の14日間無料トライアルが開始されます。無料トライアルが終了後、引き続きご利用する場合、Ship&co管理画面の「プロフィール」画面にてクレジットカードの登録が必須となります。クレジットカード登録方法はこちら。

Ship&co APIのテスト環境を利用する

Ship&co APIでテストコールを行う場合は、"test": trueを追加することで、テストの送り状を無料で作成できます。テスト環境では、テスト目的（課金対象外）のためのクレジットカード情報の追加は必要ありません。

ご注意：テストラベルは現在、UPS、DHL、佐川急便、ヤマト運輸のみ利用可能です。佐川急便とヤマト運輸は、契約アカウントの登録も不要です。テスト環境のご案内はこちら。

サブユーザー機能を使う

Ship&co APIには、サブユーザー機能を使って、データを分離して管理する事ができます。サブユーザーは、Ship&co管理画面で作成されたアカウントに所属し、各自のトークンを持ってAPIをコールし、データを分離して管理できます。全く同じ動きをするトークンを複数持つことはできません。また、サブユーザーのAPI自体は正規アカウントのトークンしか使えません（つまりサブユーザーは、自身でサブユーザーAPIをコールする事ができません）。

APIの問題に関するサポート体制

エラーメッセージや問題が発生した場合、Ship&coかスタマサポートチームがサポートします。APIコールをテストして正常に機能するかどうかを確認し、エラーの原因となる誤った情報や不足している情報を特定するお手伝いをいたします。APIコールに関する問題が発生してサポートが必要な場合は、どうぞお気軽にサポートセンターまでお問い合わせください。お問い合わせの際、最適なサポートを提供するために以下の情報を含めるようにしてください。

• 実行しようとしたAPIアクション
• APIコールの全コード（リクエストとレスポンスを含む）

出荷量の多い（3,000件/月 以上）事業者様には、Ship&coの導入を開始いただいた後で、ご利用実績に応じて料金のご相談に応じます。ご不明点は、hello@shipandco.comまでお問い合わせください。