API.Bible Logo

Documentation Navigation

Legacy Users FAQ

API.Bible Web Portal & API Service Migration

If you are a user who created an account before October 2025 or on our legacy site (scripture.api.bible), please refer to the following questions below regarding migration to our new and improved API service and web portal.



Overview

What is happening?

We are upgrading our legacy API infrastructure from the 3scale platform to a new, modern API platform and developer portal at api.bible.

As part of this upgrade:

  • The legacy API endpoint (api.scripture.api.bible) will transition to rest.api.bible
  • The 3scale developer portal will be replaced with a new API.Bible web portal
  • Active users will be automatically migrated to the new system

Why is this migration happening?

This migration allows us to:

  • Improve API performance and reliability
  • Provide a better developer experience with a modern portal
  • Introduce more flexible and scalable licensing options
  • Support future feature development more effectively

What impact will this have on my API integration?

For most users:

  • No immediate changes are required
  • Your existing API key will continue to work
  • Your current API access and limits will be preserved

During migration:

  • Requests to the old endpoint will be automatically routed to the new API
  • There may be a brief period of elevated monitoring, but no expected downtime

Do I need to do anything?

Yes — one small step:

  • You will need to reset your password when logging into the new portal for the first time

Optional (recommended):

  • Update your integration to use the new base URL (rest.api.bible)
  • Explore new plan options in the new portal

What’s changed?

  • New developer portal at api.bible
  • New API base URL: rest.api.bible
  • Improved performance and infrastructure
  • Updated account and app management experience
  • New licensing and upgrade options

How can I try the new licensing?

Once migrated:

  • Log into the new portal
  • Navigate to your app dashboard
  • Select “Upgrade Plan” to explore available options

Is commercial licensing now available?

Yes. The new platform introduces:

  • Pro plans for expanded usage
  • Custom plans for high-volume or commercial use cases

If your application requires higher limits or commercial licensing, you can upgrade directly in the portal or contact us.

Commercial Terms

For those upgrading to commercial licensing, are there changes to the “End User” attribution requirements in the new licensing structure?



Account & Access

Will my login information change?

  • Your email remains the same
  • You will need to reset your password when accessing the new portal for the first time

Will we be forced into the new licensing structure in the future?

  • Existing users will be migrated to a Legacy Plan that preserves current access and limits
  • You are not required to upgrade immediately
  • Over time, we may encourage upgrades as new features and capabilities are introduced

Will my API keys change?

No — your existing API keys will be migrated and remain valid.

Do I need to change anything in my app?

No immediate changes required.

However, we recommend updating your base URL to: https://rest.api.bible

This ensures long-term compatibility.



Security & Authentication

Authentication Method

Is the API key still passed in the header (api-key), or has the authentication method shifted to OAuth or Bearer tokens in the new system?

Password Reset Expiry

How long do I have to reset my password on the new portal before my account is considered inactive?

Multi-User Access

Does the new portal support “Teams” or multiple collaborators on a single API app, or is it still one account per app?



Technical Questions

Will the old API endpoint continue to work?

  • Yes, during the transition period
  • Requests to api.scripture.api.bible will be automatically routed to the new API
  • The old endpoint will be deprecated in the future

Will there be downtime?

  • No downtime is expected
  • The migration is designed to be seamless with DNS-level routing

Will my API rate limits change?

  • No — your current limits will carry over to your Legacy Plan
  • Any changes would only occur if you choose to upgrade your plan

Will my authorized Bible access change?

  • Your current access (including DBL-authorized content) will be preserved
  • Ensure your DBL key is properly configured if applicable

Is the new API faster or different?

Yes — the new infrastructure is designed for:

  • Better performance
  • Improved scalability
  • More reliable request handling

What happens if something breaks during migration?

We are actively monitoring:

  • Error rates (401, 5xx)
  • Traffic volume

If issues arise, we have a rollback plan to restore service quickly.



Portal & UX

How do I navigate the new portal?

The new portal is designed to be simpler and more intuitive:

  • View and manage apps from your dashboard
  • Access API keys and usage
  • Upgrade plans directly

If you need help, refer to the documentation or contact support.

Where can I find my apps and API keys?

  • After logging in, your migrated apps will appear in your dashboard
  • API keys are available within each app’s detail view

App Limitations

Is there a limit to how many “apps” I can create under the new dashboard compared to the old system?

What happened to the old 3scale portal?

  • The 3scale portal will be deprecated and eventually taken offline
  • You will be automatically redirected to the new portal when applicable


Migration & Timeline

When is this happening?

  • Migration will occur in phases, with the primary cutover happening on May 12, 2026
  • You will receive email notifications before and after migration

Will I be notified?

Yes:

  • Pre-migration notification (no expected impact)
  • Migration completion email with onboarding steps
  • Deprecation notices for legacy services

When will changes and upgrades be required?

  • What is the deadline for switching to the base URL https://rest.api.bible? (when the old base URL will be deprecated, after the “transition period”)
  • What is the deadline for upgrading from the Legacy Plan? (to answer the when re: “not required to upgrade immediately”)

What happens to inactive accounts?

  • Accounts with no activity in the past year will not be migrated immediately
  • They will receive deprecation notices and instructions if action is needed


Support

Where can I get help?

  • Visit our documentation
  • Contact support via the API.Bible portal


Advanced Engineering & Infrastructure

Response Format Changes

Are there any changes to the JSON structure, headers, or error codes in the new rest.api.bible endpoint compared to the legacy 3scale platform?

IP Whitelisting

Does the new infrastructure use a different set of outbound IP addresses that our firewall needs to allow?

SDK Compatibility

Will existing official or community SDKs (Python, JavaScript, etc.) work with the new base URL, or will they require updates?

SSL/TLS Requirements

Does the new modern API platform require a minimum version of TLS (e.g., TLS 1.2 or 1.3) that might impact legacy clients?

Webhooks

If I use webhooks for Bible content updates, do I need to re-register those in the new developer portal?



Operations & Monitoring

Deprecation Timeline

What is the specific “sunset date” for the api.scripture.api.bible endpoint after which auto-routing will cease?

Usage Analytics

Will my historical usage data (traffic logs, error rates) from 3scale be migrated, or will the new dashboard start with a clean slate?

Status Page

Is there a new status page or health-check endpoint specifically for the rest.api.bible infrastructure?