Door43 Developer Documentation
Build applications with Door43's comprehensive Bible translation resources. This documentation provides everything you need to integrate unfoldingWord's ecosystem of aligned Bible texts, translation helps, and quality assurance tools.
Built for the Open Components Ecosystem community - enabling interoperable Bible translation applications with shared, reusable components.
🎯 New Here? Start with Getting Started
Getting Started - Essential foundation for understanding the Door43 ecosystem
Before diving into technical implementation, understand why these resources exist and how they help Bible translators worldwide. This foundation will make all the technical guides much more meaningful and help you build better applications.
Recommended first read: Why unfoldingWord Translation Resources - Learn the mission and see real-world translation scenarios.
By Resource Type
| Resource | What It Contains | Format Guide |
|---|---|---|
| Bible Texts | USFM Scripture (UHB, UGNT, ULT, UST) | Bible Text Guide |
| Translation Notes | Verse-level translation guidance | Translation Notes Guide |
| Translation Words | Biblical term definitions | Translation Words Guide |
| Translation Questions | Quality assurance questions | Translation Questions Guide |
| Translation Academy | Translation methodology training | Translation Academy Guide |
| Open Bible Stories | 50 key Bible stories | Open Bible Stories Guide |
By Technical Task
| Task | Primary Guide | Supporting Guides |
|---|---|---|
| API Authentication | Door43 API Guide | - |
| Repository Discovery | Door43 API Guide | Repository Formats |
| Content Processing | Repository Format Guides | unfoldingWord Guide |
| Format Conversion | Migration Guides | Repository Formats |
| Word-Level Alignment | unfoldingWord Guide | Bible Text Guide |
| Cross-Reference Linking | Translation Words Links Guide | Translation Words Guide |
By Experience Level
- New to Door43: Start with Getting Started → Door43 API Guide
- Familiar with APIs: Jump to Repository Formats for specific resource handling
- 🔴 Building Complex Apps: Begin with unfoldingWord Developer Guide for complete architecture
Building a Bible Reading App?
1. Read: Why unfoldingWord Resources → Understand the ecosystem
2. Implement: Door43 API Guide → Get data from repositories
3. Handle: Bible Text Format Guide → Display USFM content
4. Add: Translation Notes Guide → Show verse-level helps
Time: ~4 hours | Difficulty: Intermediate
Creating a Translation Editor?
1. Study: unfoldingWord Developer Guide → Learn resource architecture
2. Implement: Door43 API Guide → CRUD operations for content
3. Handle: All Repository Formats → Support multiple resource types
4. Add: Migration Guides → Convert between formats
Time: ~2-3 days | Difficulty: Advanced
Converting Resource Formats?
1. Identify: Repository Formats → Determine source format
2. Choose: Migration Guide → Find specific conversion guide
3. Convert: Follow step-by-step instructions
4. Validate: Test converted resources
Time: ~4-8 hours | Difficulty: Intermediate
Building Automation Tools?
1. Learn: MCP Instructions → Understand automation patterns
2. Implement: API Reference for MCP → Optimize for batch operations
3. Deploy: Repository Analyzer → Automated content analysis
Time: ~1-2 days | Difficulty: Advanced
Getting Started
Understand the ecosystem and mission
- Why unfoldingWord Resources - Learn the foundational concepts and mission
- Foundation concepts before diving into technical details
unfoldingWord Developer Guide
Complete technical specification of the resource ecosystem
- Resource architecture and alignment system
- Cross-resource relationships and dependencies
- Advanced integration patterns
Door43 API Developer Guide
Practical API implementation patterns
- Authentication and repository access
- Common workflows and use cases
- Performance optimization strategies
Repository Formats
Handle specific resource types
- Resource Container - Standard unfoldingWord formats (Bible texts, translation helps)
- Scripture Burrito - Alternative Bible resource format
- Tool-Generated - translationCore and translationStudio formats
Migration & Conversion
Convert between formats
- Resource Container → Scripture Burrito conversion guides
- Format-specific migration instructions
Automation & MCP
Automated processing and analysis
- MCP instructions for AI systems
- Batch processing and repository analysis
Basic Resource Access
1. Authenticate with Door43 API
2. Discover repositories by language/organization
3. Detect resource specification (RC/SB/Tool)
4. Process content according to format guide
Multi-Resource Applications
1. Load Bible text as primary content
2. Overlay translation notes for verse guidance
3. Link translation words for term definitions
4. Add translation questions for quality checks
Format-Agnostic Processing
1. Detect resource specification automatically
2. Route to appropriate format handler
3. Extract content using specification patterns
4. Present unified interface to application
Common Questions
- New to Bible translation resources? → Start with Getting Started
- Can't find a specific resource type? → Browse Repository Formats
- API not working as expected? → Check Door43 API Guide
- Need to convert formats? → See Migration Guides
- Building automation? → Explore MCP Instructions
Recommended Learning Path
Most developers start here: Getting Started → Door43 API Developer Guide - understand the mission, then learn practical implementation patterns.
🔗 External Resources
- Door43 Content Service - Live repository browser and content platform
- Door43 API Swagger - Complete API reference documentation
- unfoldingWord.org - Organization mission and background
- Resource Container Spec - Official RC specification
- Open Components Ecosystem - Interoperable Bible translation components