認証
API へのすべてのリクエストには APIキーが含まれます。リクエストがブラウザーのセッションと照合されることはありません。
APIキーの作成
アカウントの APIキー で最大 5 個まで作成できます。ログイン中はいつでもそのページから APIキーをコピーできます。当社は APIキーを暗号化して保管し、お客様にのみ表示します。パスワードと同様に秘密にし、他者に見られた可能性がある場合は、失効させて新しいキーを作成してください。
APIキーの送信
Authorization ヘッダーで、Bearer の後にキーを続けて送信します。X-API-Key も使用できます。
curl "https://api.talismanleads.io/v1/account" \
-H "Authorization: Bearer tl_live_your_key_here"APIキーでできること
新しい APIキーではすべての操作ができます。残高、チェッカー、注文とその結果を確認できるほか、リストの保存や残高の使用を伴う POST /uploads、POST /estimates、POST /orders も使用できます。2026年11月8日より前に作成された APIキーは読み取り専用の場合があります。その場合、すべてを確認できますが、これら 3 つの呼び出しは missing_scope で拒否されます。
有効期限と IP アドレス
新しい APIキーには有効期限がなく、どのアドレスからでも使えます。2026年11月8日より前に作成された APIキーには有効期限が設定されている場合があり、期限後は expired_key で拒否されます。また、ご自身のサーバーの IP アドレスからのみ使えるように制限されている場合もあり、それ以外の場所からのリクエストは ip_not_allowed で拒否されます。いずれかを変更するには、新しい APIキーを作成し、古いキーを失効させてください。
APIキーの安全な管理
- APIキーはパスワードと同様に扱ってください。キーを持っている人は誰でもお客様の残高を使用できます。
- ご自身のサーバーでのみ使用してください。API はウェブページからの呼び出しを許可していません。
- コードやバージョン管理に含めないでください。
- APIキーが他者に見られた可能性がある場合は、すぐにアカウントで失効させてください。直ちに使えなくなります。すでに行われた注文は実行を続けます。
- API にのみ送信してください。アップロードリンクとダウンロードリンクにはそれ自体に権限が含まれているため、これらのリンクに APIキーを送信しないでください。
APIキーが拒否された場合
誤っている、失効した、または期限切れの APIキーには 401 が返ります。ブロックされた APIキーまたはアカウントには 403 が返ります。エラーをご覧ください。