概要
Onboardingから返却されるエラーとその詳細についてのドキュメントです。
目次
ステータスコード一覧
以下がOnboarding JavaScriptタグから呼び出しているAPIのステータスコード一覧です。
ステータスコード | メッセージ | 概要 |
401 | token error | トークンが存在しない |
403 | auth domain error | ドメインが許可リストに登録されていない |
403 | black list error | ドメインがブラックリストに登録されている |
404 | no params | 必須パラメータが渡されていない |
404 | params is incorrect | パラメータが間違っている |
エラー内容の確認方法
以下の手順でエラー内容の確認を行なってください。
※Google Chromeを例に説明しています。
- 開発者ツールを開く
- ［Console］をクリック
- コンソールに表示された
[ERROR]Onboarding API...から始まるログを確認 Status Code:の後にステータスコード一覧の「ステータスコード」が表示されますMessage:の後にステータスコード一覧の「メッセージ」が表示されます
エラー発生時の対処方法
発生したエラーの内容が下記に明記されていない場合があります。
エラー原因が不明な場合や解決が難しい場合、お気軽にOnboarding CSチームまでお問合せください。
401エラー
token error
プレビューモードでのみ発生するエラーとなります。
Onboarding管理画面からプレビューボタンをクリックするとトークンが生成されます。そのトークンの認証が切れていることが原因です。
対応内容
Onboarding管理画面からプレビューボタンをクリックし、再度ガイドを起動してください。
403エラー
auth domain error
アクセス元のドメインが許可されていないことによるエラーとなります。
対応内容
以下を参考に管理画面からドメインを追加してください。
black list error
ブラックリストに登録されたURLからアクセスがあった場合に発生するエラーです。
Onboarding JavaScriptタグにブラックリストの設定が可能です。
対応内容
Onboardingインテグレーションガイドを参照し、ONB.black_list設定を修正してください。
404エラー
Onboardingではお客様の所属する企業、サイトに対してIDを割り当てており、それらをOnboarding JavaScriptタグからクエリパラメータとして送信いただき、その情報に一致するガイド情報を返却しています。
require params
パラメータの識別IDが渡されていないことによるエラーとなります。
params is incorrect
パラメータの識別IDが間違えていることによるエラーとなります。
対応内容
管理画面からOnboarding JavaScriptタグを取得し、お客様のソースコードに埋め込んだうえで、再度ご確認ください。
それでも解決しない場合はOnboarding CSチームにご連絡ください。
