API для пополнения баланса кредитных карт Agent Stripe

Введение

API Agent Stripe Credit Top-Up позволяет ИИ-агенту проверять баланс кредитов на счете и, в пределах установленных пользователем лимитов, списывать средства с сохраненного способа оплаты Stripe для пополнения счета.

Данный API не является x402. Для этого требуется существующая учетная запись BuiltWith и отдельно настроенный ключ выставления счетов агента. Для безучетных платежей Base USDC используйте BuiltWith x402 payments page.

Все три основные точки доступа размещены на payments.builtwith.com.

Прежде чем агент сможет использовать эти конечные точки, пользователь должен включить выставление счетов через API агента и настроить лимиты расходов. https://payments.builtwith.com/agent-payment-api-config.
После ручной активации агенты могут использовать устаревшие псевдонимы путей mppx для тех же операций пополнения счета Stripe. https://api.builtwith.com/mppx. Эти псевдонимы не являются протоколом x402 или протоколом проверки платежей.
Аутентификация

Скопируйте отдельно заданный ключ выставления счетов агента со страницы конфигурации выставления счетов и отправьте его в заголовке Authorization. Общие ключи API BuiltWith и временные токены устройств bw- не позволяют приобретать кредиты.

Authorization: Bearer YOUR_AGENT_BILLING_KEY

Устаревший параметр запроса KEY устарел, поскольку учетные данные в URL-адресах могут сохраняться в журналах и истории браузера.

Запросы с отсутствующим, недействительным или отключенным ключом возвращают HTTP 401. Учетные записи с приостановленной оплатой возвращают HTTP 403.

🤖 Подсказка от ИИ-агента
Reference https://api.builtwith.com/llms.txt and
https://raw.githubusercontent.com/builtwith/builtwith-ai-sdk/refs/heads/main/README.md
Add BuiltWith Agent Stripe Credit Top-Up API support to my app. This is saved-card
account billing, not x402. Check the account API-credit balance and, if below 1000,
purchase 2000 more using a unique Idempotency-Key and the scoped Agent Billing Key.
If the legacy mppx path aliases are desired, use
https://api.builtwith.com/mppx/openapi.json and the Agent Payment API routes
https://api.builtwith.com/mppx/api-discovery,
https://api.builtwith.com/mppx/api-configuration, and
https://api.builtwith.com/mppx/api-purchase.
mppx Agent Payment API Aliases

После ручной активации агенты могут использовать совместимые с mppx псевдонимы доменов API для существующего API платежей агентов. Эти маршруты используют ту же аутентификацию по ключу API BuiltWith, сохраненный способ оплаты Stripe и лимиты расходов API-биллинга агентов, описанные ниже.

Открытие

GET https://api.builtwith.com/mppx/openapi.json

Маршруты

GET https://api.builtwith.com/mppx/api-discovery

GET https://api.builtwith.com/mppx/api-configuration

POST https://api.builtwith.com/mppx/api-purchase

{ "credits": 2000 }

Отправьте ключ API агента в заголовке Authorization: Bearer или в качестве параметра запроса KEY, точно так же, как и в случае с конечными точками API платежей агента на payments.builtwith.com.

GET /v1/billing/api-discovery — Кредитовый баланс

Возвращает текущий баланс средств API на счете.

Запрос

GET https://payments.builtwith.com/v1/billing/api-discovery?KEY=00000000-0000-0000-0000-000000000000

Поля ответа
ПолеТипОписание
credits_totalnumberОбщая сумма средств, когда-либо зачисленных на счет.
credits_usednumberКредиты, израсходованные на вызовы API на данный момент.
credits_availablenumberОстаток доступных кредитов (общая сумма минус использованные). Это то, что агент должен проверить перед выполнением вызовов API.
Пример ответа
{
  "credits_total": 10000,
  "credits_used": 1234,
  "credits_available": 8766
}
GET /v1/billing/api-configuration — Лимиты расходов

Возвращает установленные лимиты расходов и сумму уже использованного ежемесячного лимита. Агент должен проверить это перед попыткой покупки, чтобы избежать отклоненных запросов.

Запрос

GET https://payments.builtwith.com/v1/billing/api-configuration?KEY=00000000-0000-0000-0000-000000000000

Поля ответа
ПолеТипОписание
max_per_purchasenumberМаксимальное количество кредитов, которое агент может приобрести за одну транзакцию.
max_monthlynumberМаксимальное количество кредитов, которое агент может приобрести в течение текущего календарного месяца.
monthly_purchasednumberКредиты, уже приобретенные агентом в этом календарном месяце.
monthly_remainingnumberСколько ещё кредитов можно приобрести в этом месяце, прежде чем будет достигнут месячный лимит?
cost_per_2000_credits_usdnumberСтоимость покупки на сумму не менее 2000 кредитов в долларах США. Используйте эту информацию для оценки стоимости планируемой покупки.
Пример ответа
{
  "max_per_purchase": 5000,
  "max_monthly": 20000,
  "monthly_purchased": 5000,
  "monthly_remaining": 15000,
  "cost_per_2000_credits_usd": 99.00
}
POST /v1/billing/api-purchase — Купить кредиты

Списание средств с сохраненного пользователем способа оплаты Stripe и немедленное зачисление на счет. Покупка осуществляется в соответствии с лимитами на одну покупку и на месяц, установленными в настройках выставления счетов Agent API.

Запрос

POST https://payments.builtwith.com/v1/billing/api-purchase

Отправьте ключ API агента в качестве параметра. Authorization: Bearer заголовок или в качестве ?KEY= Параметр запроса. Тело запроса должно быть в формате JSON.

Текст запроса
ПолеТипНеобходимыйОписание
creditsnumberДаКоличество кредитов для покупки. Минимум 2000. Не должно превышать max_per_purchase или оставшуюся часть ежемесячного пособия.
Успешный ответ (HTTP 200)
ПолеТипОписание
successbooleantrue
credits_purchasednumberКредиты зачислены на счет.
cost_usdnumberСумма к оплате указана в долларах США.
payment_idstringИдентификатор платежного намерения Stripe для сверки.
credits_availablenumberОбновление доступного кредитного баланса после покупки.
Пример текста запроса
{ "credits": 2000 }
Пример успешного ответа
{
  "success": true,
  "credits_purchased": 2000,
  "cost_usd": 99.00,
  "payment_id": "pi_3abc123xyz",
  "credits_available": 10766
}
Ответы об ошибках
HTTPЗначение
400Сбой проверки — количество кредитов меньше 2000, превышен лимит на одну покупку или превышен месячный лимит.
401Отсутствует или недействителен ключ API агента.
402Платеж через Stripe не удался или в системе не указан способ оплаты, за который можно произвести оплату.
403Выставление счетов приостановлено.
405Метод недопустим — конечная точка требует POST-запроса.
Специальные домены

Мы ведём два списка, которые пригодятся вам при поиске доменов: списки игнорирования и списки BuiltWith Suffix.

Список игнорирования
TЭто наш внутренний список доменов, которые мы не индексируем. Они либо заблокированы, либо содержат слишком много вводящих в заблуждение технологий, либо слишком много поддоменов с пользовательским контентом.

BuiltWith Список суффиксов
Это основано на Список публичных суффиксов но включает множество дополнительных записей для компаний с поддоменами, которые следует считать доменами верхнего уровня. Этот список обеспечивает лучшую видимость внутренних веб-сайтов, например, он выводит northernbeaches.nsw.gov.au на верхний уровень по сравнению с nsw.gov.au.

Игнорировать домены (XML, JSON or TXT)
https://api.builtwith.com/ignoresv1/api.json
Суффиксные домены (XML, JSON or TXT)
https://api.builtwith.com/suffixv1/api.json
Коды ошибок

Обратите внимание, что отправка сообщений об ошибках в этом формате не может быть гарантирована, ваша реализация должна также рассматривать коды ответа, отличные от 200, как ошибки. Свойство Lookup будет иметь значение null (json) или не будет предоставлено (xml), если ошибка связана с сервером. Просмотреть все возможные правильно сформированные коды ошибок.

Условия эксплуатации

Наш стандартные условия распространяется на использование всех наших API.

В целом, вы можете использовать API для улучшения своего продукта различными способами. Единственное ограничение — вы не можете перепродавать данные в их исходном виде или предоставлять дублирующий функционал builtwith.com и связанным с ним сервисам.