概要

Onboardingから返却されるエラーとその詳細についてのドキュメントです。

目次

1. リクエストパラメータ一覧
2. エラー内容の確認方法
3. エラー発生時の対処方法
• 400エラー
• 401エラー
• 403エラー
• 404エラー

リクエストパラメータ一覧

以下がOnboarding JavaScriptタグから呼び出しているAPIのステータスコード一覧です。

エラー内容の確認方法

以下の手順でエラー内容の確認を行なってください。

※Google Chromeを例に説明しています。

1. 開発者ツールを開く
2. 「Network」をクリック
3. 左上の検索欄にv2/onboardingを入力し、表示結果をクリック
4. 「Headers」をクリック
5. obd-message欄を参照

エラー発生時の対処方法

発生したエラーの内容が下記に明記されていない場合があります。

エラー原因が不明な場合やエラー解決が難しい場合、お気軽にOnboarding CSチームまでお問合せください。

400エラー

referer empty

Onboardingでは、アクセスが許可された安全なユーザーを見分けるためリファラーを参照しています。

お客様サイトの Referrer-Policy の設定によっては、リクエスト時にリファラーが送信されない場合がございます。

一例として、以下のような設定がされている場合にエラーが発生します。

• no-referrer が設定された場合

全てのリクエスト時に、リファラー情報を送信しない設定

• same-origin が設定された場合

クロスオリジンの場合にリファラー情報を送信しない設定

例：お客様サイトのオリジンがhttps://example.com として、OnboardingのAPIエンドポイントがhttps://api.onboarding-app.io であるとする。

その場合、オリジンが違うのでリクエスト時にリファラー情報が送信されないといったことが起きます。

HTMLに直接 Referrer-Policy が設定されているケースもございます。

<meta name="referrer" content="no-referrer">

対応内容

Referrer-Policy の設定を修正ください。

対応が難しい場合はOnboarding CSチームまでご相談ください。

401エラー

token error

プレビューモードでのみ発生するエラーとなります。

Onboarding管理画面からプレビューボタンをクリックするとトークンが生成されます。そのトークンの認証が切れていることが原因です。

対応内容

Onboarding管理画面からプレビューボタンをクリックし、再度ガイドを起動してください。

403エラー

auth domain error

アクセス元のドメインが許可されていないことによるエラーとなります。こちらの設定はOnboarding CS チームが設定しており、お客様の管理画面からの操作はできません。

対応内容

Onboarding CSチームにご連絡ください。

その際に登録が必要なドメインをご用意いただけるとスムーズに対応が可能です。

black list error

ブラックリストに登録されたURLからアクセスがあった場合に発生するエラーとなります。

Onboarding JavaScriptタグにブラックリストの設定が可能です。

対応内容

Onboardingインテグレーションガイドを参照し、ONB.black_list設定を修正してください。

404エラー

Onboardingではお客様の所属する企業、サイトに対してIDを割り当てており、それらをOnboarding JavaScriptタグからクエリパラメータとして送信いただき、その情報に一致するガイド情報を返却しています。

require params

パラメータが渡されていないことによるエラーとなります。

対応内容

Onboarding CSチームにご連絡ください。

params is incorrect

パラメータが間違えていることによるエラーとなります。

対応内容

Onboarding CSチームにご連絡ください。

guide not found

パラメータに一致するOnboardingのガイドが存在しないことによるエラーとなります。

対応内容

Onboarding CSチームにご連絡ください。

Onboarding ヘルプページ