Overview

Welcome to the Overview section of the Semble GraphQL Public API documentation. In this section, we will be taking a high-level view of what GraphQL is, what Semble's API offers, and why it's a fantastic tool for developers.

What is GraphQL?

GraphQL is a data query and manipulation language for APIs and a runtime for executing those queries with your existing data. It was developed by Facebook in 2012 and has since been adopted by many organisations around the world due to its efficiency and flexibility.

Unlike traditional REST APIs, which return fixed structures of data, GraphQL allows clients to specify exactly what data they need. This reduces the amount of data transferred over the network, making operations faster and more efficient.

What is Semble GraphQL Public API?

Semble GraphQL Public API is a robust and flexible interface that allows you to integrate with Semble services seamlessly. Our public API is designed to provide you with direct access to Semble's vast array of services, using the power and versatility of GraphQL.

How Does It Work?

Semble GraphQL Public API works by accepting GraphQL queries and executing them against its data. These queries allow you to retrieve precise data structures, which reduces unnecessary data fetches and increases performance.

For example, a query might look something like this:

query {
  patients(search: "Doe", pagination: { page: 1, pageSize: 5 }) {
    data {
      id
      firstName
      email
    }
  }
}

In this query, we are asking for the firstName and email of a user with an id of "1". The server would return a JSON object with exactly these fields.

For example, the output might look something like this:

{
  "data": {
    "patients": {
      "data": [
        {
          "id": "1",
          "firstName": "John",
          "email": "john.doe@example.com"
        },
        {
          "id": "2",
          "firstName": "Jane",
          "email": "jane.doe@example.com"
        }
      ]
    }
  }
}

Core Principles

At Semble, we're driven by principles that ensure we provide the best tools for developers:

• Efficiency: We believe in lean and efficient operations, reducing unnecessary data transfers and increasing performance.
• Flexibility: Our tools are designed to adapt to your needs, providing you with the ability to request exactly what data you need.
• Empowerment: We're dedicated to empowering developers by providing comprehensive and understandable documentation, and an API that is easy to use yet powerful.

We hope this overview provides you with a solid understanding of what the Semble GraphQL Public API is and how it works. As you proceed through our documentation, you'll gain more in-depth knowledge of how to use the API to its full potential. Thank you for choosing Semble. Let's build something great together.