Conyac Requester API v1 スタートアップガイド

はじめに

Conyac APIは認証にOAuth 2.0をもちいたRESTfulなWebサービスとして実装されています。翻訳依頼に必要な各機能へのアクセスは直感的なURLやパラメータを用いています。

さらに、Conyac APIサーバーから返ってくる情報は、すべてJSON形式ですので、プログラミング言語、プラットフォームを問わず、さまざまなWebサービスやモバイルアプリケーションで容易にデータを利用することが可能です。

このスタートアップガイドでは、Conyac Requester API v1を利用する方法について説明します。詳細についてはConyac Requester API v1 リファレンスをご覧ください。

アカウントの登録

Conyac APIを利用したアプリケーションを作成するには、Conyacの依頼者アカウントの登録が必要です。

アプリケーションの新規登録

最初に、Conyacの依頼者アカウントでログインし、左上のConyacロゴの下のアイコンの右側にあるドロップダウンメニューから、開発者向けの設定を選択します。

開発者向けの設定画面の右上にある、緑色のアプリケーションの追加ボタンをクリックすると、アプリケーションの新規登録画面が開きます。APIを使用するアプリケーションの設定に応じて、以下の欄を入力します。

  • 名前（必須） アプリケーションの名前を入力します。(例: YourConyacApp)

  • サービスサイトURL
    Webサービスの場合はサーバーのURL、ネイティブ（モバイル）アプリの場合は公式サイトのURLを入力します。 (例: https://yourconyacapp.com )
  • 説明（必須）
    アプリケーションの説明（メイン機能、用途）などの詳細情報を入力します。
  • OAuth コールバックURL（必須）
    OAuth 2.0認証で使用するコールバックURLを入力します。(例: https://yourconyacapp.com/oauth/conyac/callback )
  • コールバック通知URL
    アプリケーションがConyacからのコールバック通知を受け取るURLを入力します。(例: https://yourconyacapp.com/conyac/notifications ) コールバック通知に関しては、Conyac API リファレンスマニュアルを参照してください。

アプリケーションの登録が完了すると、アプリケーションに固有なアプリケーションIDとSecretが発行されます。(それぞれ、64文字のランダムな文字列となります。） 上記の2つのパラメータ、およびOAuthコールバックURLはOAuth 2.0認証で必要となりますので、大切にメモしておきます。(特に、Secretは公開しないように注意します。）

認証のテスト

認証コードの取得

アプリケーションの使用認証を行うには、Conyacの認証URL( https://biz.conyac.cc/oauth/authorize )に以下のパラメータを用いてアクセスします。

パラメータは以下の通りとなります。

  • response_type
    code
  • client_id
    アプリケーションID
  • redirect_uri
    OAuthコールバックURLをUTF-8でURLエンコードしたもの

認証のテストとして、例として、上記のURLとパラメータを結合した以下の文字列をブラウザのURL欄に打ち込んで、アクセスします。

https://biz.conyac.cc/oauth/authorize?response_type=code&client_id=df256790540e639c9ef7a1debc31ae09405170c5b51b76d4a123b910cc032e56&redirect_uri=https%3A%2F%2Fyourconyacapp.com%2Foauth%2Fconyac%2Fcallback

(注意: client_idとredirect_uriは各アプリケーションによって異なります。皆さんが実際に登録して得られたパラメータを用いて使用してください。)

Conyacにログインしていない場合は、ログイン画面が出ます。以下のようなアプリケーションの使用許可の画面が出れば、成功です。

‘認証’ボタンをクリックするとブラウザのURL欄が以下のようになっています。 (ウェブページにアクセスできないという内容の画面が出ますがこれは無視します。)

https://yourconyacapp.com/oauth/conyac/callback?code=daaefad48a50797ff9b424e4ac948dda87bb8238d67090b4fa6909726f235ad3

ここで得られたパラメータに含まれるcodeの文字列(64文字）をメモしておきます。

アクセストークンの取得

アクセストークンを取得するにはには、ConyacのトークンURL (https://biz.conyac.cc/oauth/token) 以下のパラメータを用いてアクセスします。

  • client_id
    アプリケーションID
  • client_secret
    Secret
  • redirect_uri
    OAuthコールバックURLをUTF–8でURLエンコードしたもの
  • grant_type
    authorization_code
  • code
    上記で得られたしたcode

ここでは、Webブラウザではなく、curlコマンドを利用します。

$ curl https://biz.conyac.cc/oauth/token \
   -d client_id=df256790540e639c9ef7a1debc31ae09405170c5b51b76d4a123b910cc032e56 \
   -d client_secret=f11d67fe92e97c371dec524e989ed3289828e604f5c4c4b545e7392dfb47d7a3 \
 -d redirect_uri=https%3A%2F%2Fyourconyacapp.com%2Foauth%2Fconyac%2Fcallback \
 -d grant_type=authorization_code \
 -d code=b35ec927409e96ce3676ccc77e27240a205d4fe5e74d446c34e42e2f5f72c5ca \
 -X POST

結果として、以下のようにJSONデータ内でaccess_tokenが得られれば成功です。

{
  "access_token": "a5adb9bc60a9ed4438f7db1443971181b1dab875f0d6994d3245aa4cee7e34b8",
  "token_type": "bearer",
  "expires_in": null,
  "refresh_token": null,
  "scope": ""
}

APIのテスト

自分（依頼者自身）の情報を取得する

$ curl -X GET https://biz.conyac.cc/api/v1/my?access_token=a5adb9bc60a9ed4438f7db1443971181b1dab875f0d6994d3245aa4cee7e34b8

{
  "success": true,
  "message": "the user information is successfully obtained.",
  "id": 107,
  "login": "test10",
  "created_at": "2014-06-10T10:32:38.000+09:00",
  "updated_at": "2014-06-10T10:32:38.000+09:00",
  "locale": "en",
  "picture_url": "https://secure.gravatar.com/avatar/55502f40dc8b7c769880b10874abc9d0.png?d=identicon&r=PG&s=48",
  "translator": false,
  "email": "test@example.com",
  "default_organization_id": 4,
  "default_organization": {
    "id": 4,
    "name": "test10",
    "plan_id": 1,
    "user_id": 107,
    "default": 1,
    "description": null,
    "created_at": "2014-06-10T10:32:38.000+09:00",
    "updated_at": "2014-06-10T10:32:39.000+09:00",
    "url": "https://biz.conyac.cc/api/v1/organizations/4",
    "html_url": "https://conyac.cc/b/organizations/4",
    "point": 100250,
    "available_point": 100250
  }
}

これで、APIを使う準備ができました。APIの機能全般については、エンドポイントをご覧ください。 （実際に依頼を行うには、あらかじめConyacサイトでのポイントの購入が必要となります。）

Last Updated on 16 Jun 2017 at 13:26