Skip to main content

Getting Started with Onebox API

New to Onebox?

Starting your first integration? Contact our business team to begin the onboarding process:

πŸ“§ Business inquiries: channels@oneboxtds.com πŸ“§ Technical support: api-support@oneboxtm.com

What is Onebox?​

Onebox is the first Global Ticket Distribution System for the entertainment industry. We develop technology to connect live events and activities with sales channels from a centralized all-in-one ticketing platform, empowering sales, profits, and audiences.

APIs to Unlock the Potential of Your Ticketing​

Through our powerful APIs, we help your business grow by connecting you to an entertainment marketplace, enabling you to:

  • 🌍 Unlock new markets and sell tickets to the best live entertainment shows
  • ⚑ Get real-time rates and inventory availability without quotas or limitations
  • 🎫 Create barcoded tickets for direct venue access without vouchers
  • πŸ”— Connect seamlessly to a global network of events and promoters

Our API-First Approach​

Our API-first strategy consists of treating the API not as middleware but as a software product that empowers developers, enables partnerships, and accelerates innovation. This is a big shift from integration-first operations in which APIs are typically created and then forgotten.

Being API-first means anticipating that an API may have many use cases and enable numerous business opportunities.


This guide will walk you through the complete integration process from initial contact to production deployment.


πŸš€ Integration Process Overview​


Step 1: Initial Contact & Business Agreement​

Contact Our Business Team​

Email channels@oneboxtds.com with the following information:

  • Company name and brief description
  • Type of integration (sales channel, access control, event manager, etc.)
  • Expected volume (tickets per month/year)
  • Target markets (countries/regions)
  • Technical contact information

What Happens Next?​

  1. Our business team will review your request
  2. Schedule an introductory meeting to discuss your needs
  3. Negotiate commercial terms and contract
  4. Once the contract is signed, you'll be onboarded to technical support
Timeline

The business negotiation process varies depending on complexity. Plan for 1-4 weeks from initial contact to contract signature.


Step 2: Receive Test Environment Credentials​

Once the contract is signed, our technical team will provide you with test environment credentials:

Test Credentials Package​

You will receive:

CredentialDescriptionExample Value
channel_idYour unique channel identifier123
client_idOAuth client identifierseller-channel-client
client_secretOAuth secret / API Keyxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Environment URLTest API base URLhttps://api.oneboxtds.net
Keep Credentials Secure

Never share credentials publicly or commit them to version control. Use environment variables in your applications.

Test Environment Access​

  • Base URL: https://api.oneboxtds.net
  • OAuth Token: https://api.oneboxtds.net/oauth/token
  • Test data: Pre-configured events and sessions for testing

Step 3: Development & Integration​

Quick Start​

  1. Authenticate - Obtain your OAuth2 access token

  2. Explore the Catalog - Search for events and sessions

  3. Create Orders - Implement the booking and purchase flow

  4. Manage Orders - Handle order details, refunds, and cancellations

Development Resources​

Testing Your Integration​

Use the test environment to:

  • βœ… Test the complete purchase flow end-to-end
  • βœ… Handle different event types (EVENT, ACTIVITY, PASS)
  • βœ… Test error scenarios (sold out, expired cart, invalid data)
  • βœ… Verify webhook integrations
  • βœ… Test refund and cancellation flows
Development Time

Most integrations take 2-6 weeks depending on complexity. Ensure you test all scenarios thoroughly before requesting certification.


Step 4: Certification Process​

Once your integration is complete and tested in the test environment, you must pass a certification process before accessing production. This is a mandatory step to ensure the quality and reliability of your integration.

Certification Process DiagramCertification Process Diagram

What is Certification?​

A live video conference where you demonstrate your complete integration flow while our technical team monitors the API calls in real-time using our audit system. This ensures everything is implemented correctly before going to production.

Prerequisites - Before You Request Certification​

Ensure you have completed all of the following in the test environment:

  • βœ… Complete purchase flow: Search, cart creation, checkout, payment, and order confirmation
  • βœ… Error handling: Properly handle all error scenarios (sold out, expired cart, invalid data, etc.)
  • βœ… Multiple event types: Tested with EVENT, ACTIVITY, and PASS types
  • βœ… Webhook integration: If applicable to your use case
  • βœ… Refund/cancellation flows: If you will handle post-purchase operations
  • βœ… Demo environment ready: Working integration ready to showcase live
Important

Do NOT request certification until your integration is fully complete and tested. If issues are found during certification, you'll need to reschedule for another meeting.

How to Request Certification​

Step 1: Email api-support@oneboxtm.com

Subject: Certification Request - [Your Company Name]

Email content must include:

  • Your channel_id (test environment)
  • Brief description of your integration scope
  • Confirmation that you've completed all prerequisites above
  • 2-3 proposed dates/times for the video call (include your timezone)

Step 2: Wait for confirmation

Our team will respond within 1-2 business days to confirm the certification meeting date and time.

The Certification Meeting​

Duration: Approximately 1 hour

Platform: Google Meet (link provided by Onebox)

What happens during the meeting:

  1. πŸ“Ί Screen sharing: You share your screen to demonstrate your integration
  2. 🎬 Live demonstration: You perform the complete purchase flow in real-time
  3. πŸ” Monitoring: Onebox team monitors all API calls in our audit system
  4. ❓ Q&A: We may ask questions about your implementation
  5. βœ… Review: We verify all calls are correctly implemented
Best Practices for the Demo
  • Test your integration one final time before the meeting
  • Have your test credentials ready
  • Ensure stable internet connection
  • Prepare to explain your error handling logic
  • Be ready to show different scenarios (happy path + edge cases)

Certification Outcomes​

βœ… Success - Certification Passed​

If everything works correctly and all API calls are properly implemented:

  • Result: Certification approved ✨
  • Next step: Production credentials will be created and delivered
  • Timeline: Usually 1-2 business days (sometimes same day)

⚠️ Issues Found - Certification Failed​

If there are problems during the demonstration or issues found in the audit system:

  • Result: Certification not approved
  • Next step: We'll provide detailed feedback on what needs to be fixed
  • Action required: Fix the issues and request a new certification meeting
  • Timeline: Schedule follow-up after fixes are implemented
Certification Timeline
  • Scheduling: Book 1-2 weeks in advance for availability
  • Production credentials: Same day to 2 business days after passing
  • Retry: If you fail, you can reschedule after fixing issues

Step 5: Production Access​

After successful certification, you'll receive production credentials:

Production Credentials​

CredentialDescription
channel_idProduction channel identifier
client_idProduction OAuth client ID
client_secretProduction API Key
Environment URLhttps://api.oneboxtds.com
Production Environment

Production credentials access real data and real transactions. Handle with extreme care:

  • βœ… Use secure credential storage (secrets management)
  • βœ… Monitor error rates and API responses
  • βœ… Implement proper logging and alerting
  • ❌ Never use test credentials in production
  • ❌ Never use production credentials in test

Going Live Checklist​

Before launching to customers:

  • All endpoints use production URLs (api.oneboxtds.com)
  • Production credentials stored securely
  • Error handling and retry logic implemented
  • Monitoring and alerting configured
  • Customer support team trained
  • Rollback plan prepared

πŸ“š Next Steps​

Essential Reading​

  1. Environments - Understand test vs production
  2. Authentication - OAuth2 implementation
  3. API FAQ - Common questions answered

Integration Guides by Use Case​

Getting Help​


🎯 Success Stories​

Our API powers integrations with hundreds of sales channels worldwide, processing millions of tickets annually. Welcome to the Onebox ecosystem!

Onebox Ticket System DistributionOnebox Ticket System Distribution