GraphQL API Documentation
This page serves as the entry point for understanding and utilizing our GraphQL API. GraphQL is a powerful query language for APIs and a server-side runtime for executing those queries by using a type system you define for your data.
Why we use GraphQL
GraphQL offers significant advantages over traditional REST architectures, optimizing the experience for both frontend developers and application performance:
-
Efficiency: Ask for what you need, get exactly that
Unlike REST, where endpoints return fixed data structures, GraphQL allows the client to specify exactly the data fields they require. This prevents over-fetching (receiving unwanted data) and under-fetching (requiring multiple round trips to get related data).
Example: To get a list of user names and their latest order total, a client makes a single, precise request.
-
Strong Type System: Built-in validation and stability
The entire API is defined by a schema, which dictates the types of data that can be queried. This provides:
- Reliability: Built-in validation ensures queries are syntactically correct and request valid fields.
- Discoverability: The schema is a single source of truth, enabling powerful documentation and developer tools (like the GraphQL Playground).
-
Declarative Data Fetching: Faster development
Developers can describe their data requirements declaratively. When the requirements change, the query changes, not the backend API structure. This accelerates frontend development and simplifies backend maintenance.
Navigating the documentation
Use the sidebar to explore the comprehensive API reference:
| Section | Description |
|---|---|
| Queries | The core read operations. Find out how to fetch specific data points from the system. |
| Mutations | The write operations. Learn how to create, update, or delete data on the server. |
| Types | The foundational data objects (e.g., User, Product, Order) that define the entire schema. |
| Scalars | Primitive data types (e.g., ID, String, Int, DateTime). |
Getting Started
To begin integrating with the API:
- Find your endpoint: Our primary GraphQL endpoint is:
https://api.boomi.com/graphql - Explore the Schema: Use a GraphQL client with the endpoint above to browse the schema interactively.
- Construct a Query: Navigate to the Queries section in the sidebar to find the data you need and learn how to structure your request.
