共通仕様

オーガニゼーションとユーザー

ABEJA Platform におけるリソース(チャンネルやデータソース)は、「オーガニゼーション (組織)」 という単位で管理されています。 リソースを使用するために認証/許可された単位を「ユーザー」という単位で管理されています。また、ユーザごとに実行できる操作の種類によって「ロール (役割)」 を割り当てが可能です。

オーガニゼーションおよび管理者ユーザーの情報は ABEJA より発行いたします。

ロールとユーザーの権限

ロールおよび、実行できる操作の種類については以下となります。 ユーザーは所属するオーガニゼーションにおいて、以下のいずれかのロールを割り当てられています。

ロール 説明
Admin (管理者) オーガニゼーションに属するすべてのリソースの閲覧および変更(新規作成 / 更新 / 削除)が可能です。
Developer (開発者) オーガニゼーションに属するリソースのうちモデルの開発に関わるリソースの閲覧および変更が可能です。
Regular (通常) オーガニゼーションに属するリソースの閲覧のみが可能です。

認証

API を利用するための以下の認証情報は、ABEJA Platform管理画面右上の 「ユーザ名」 より確認いただけます。

  • オーガニゼーションの ORGANIZATION_ID
  • 管理者ロールをもつユーザーの USER_ID
  • 管理者ロールをもつユーザーの PERSONAL_ACCESS_TOKEN

認証は Basic 認証で行います。ユーザー名とパスワードには以下のものを指定してください。

  • ユーザー名 user-{USER_ID}
  • パスワード {PERSONAL_ACCESS_TOKEN}
$ curl --user user-9876543210321:b9555a16ad6513d91af399807c0c22bff3484c64 ...

リクエスト・ヘッダー

API のリクエスト・ボディに JSON を指定するときは必ず、Content-Type リクエスト・ヘッダーに application/json を指定してください。

$ curl -H "Content-Type: application/json" ...