接続する

最初の接続の流れ

基盤に初めて接続するときの、全体の流れです。最初のAPI呼び出しが成功するまでを、3つのステップに分けて示します。

接続の方法には、利用者としての接続と、serviceとしての接続があります。ここでは、利用者としての接続を例にします。利用者とserviceの違いは、用語集にあります。

ステップ1　接続情報を依頼する

基盤の接続先や、ログインの設定は、利用環境ごとに違います。まず、環境管理者に、接続情報を依頼します。

できたこと: 接続に必要な値が、すべてそろった。

受け取った情報で、利用者のログインを行い、アクセストークンを取得します。そのトークンで、GET /v1/meを呼びます。GET /v1/meは、「いま、誰として接続しているか」を返すAPIです。

できたこと: GET /v1/meが200で、利用者のidと権限を返した。これだけでは、すべてのAPI機能が有効とは判定できません。

詳しくは、利用者として接続する。人の操作なしに動く処理は、serviceとして接続する。

表の一覧を取得し、表の定義を読んで、検索します。次に、検証用の表で、行の追加と更新を試します。

できたこと: 検証用の表で、行を読み、書けた。

症状	確認すること
401（`TOKEN_EXPIRED`）	アクセストークンの期限切れです。リフレッシュトークンで取り直します（発行されていなければ、ログインし直します）
ログインの直後に、401（`TOKEN_INVALID`）になる	新しいセッションの方式より前の稼働版の利用環境では、短い反映待ちのことがあります。利用者として接続するの「ログインの直後とセッションの期限」を参照
401（`SESSION_EXPIRED`など）	セッションが切れています。ログインからやり直します。利用者として接続するの「ログインの直後とセッションの期限」を参照
401が続く	接続先、client_id、有効期限、セッションを確認
403	現在の権限と、MFAを確認
TLSの検証に失敗する	検証を無効にせず、環境管理者が渡した証明書を使う

エラーの一覧は、エラーと再試行にあります。

文書の例は、合成のデータです。実際に接続できるかは、利用環境ごとに、最初の接続で確認してください。