iObeya currently provides 3 different APIs: Legacy, Facade and NextGen.
Each API exists for a specific purpose and reflects the evolution of our system over time:
Legacy API: our original implementation on our V4 version, still maintained for backward compatibility with existing integrations.
Facade API: acts as a simplified layer on top of the Legacy API, offering a more consistent developer experience while ensuring stability.
NextGen API: our modern and future-oriented solution, designed for performance, scalability and new features.
This documentation explains the role of each API, when to use them and how they fit into our overall roadmap.
Overview of Available APIs
API | iObeya Version | Purpose | Status |
|---|---|---|---|
Legacy API | v4 (online, onprem) | Original API, supports existing integrations | Available |
Facade API | v4 (online, onprem) | Wrapper over Legacy, simplified endpoints | Available |
NextGen API | NextGen | Modern API, new features, better performance | Early Adopters |
API Details
Legacy API
Base URL:
customer.iobeya.com/s/jorcustomer.api.iobeya.com/v0Authentification Method: JWT (OAuth 2)
Documentation: Contact Us
Facade API
Base URL:
customer.api.iobeya.com/v1Authentification Method: JWT (OAuth 2)
Documentation: here.