TBInt API Reference (Beta)

The TBInt API is built with GraphQL, a powerful query language that enables you to request only the data you need. Unlike REST APIs, which require multiple endpoints to return different sets of data, GraphQL exposes a single endpoint. This endpoint provides access to functions called queries (for reading data) and mutations (for writing data), allowing you to specify the structure of the data returned.

GraphQL Schema

A GraphQL schema is a blueprint that represents the data structure of the API. It defines the type hierarchy, fields, queries, and mutations, and outlines the functionality available to the client. In simple terms, "A schema defines a collection of types and the relationships between these types." Developers can utilize the schema as a form of documentation and as a guide for generating code to interact with the API.

Queries and Mutations

Queries and mutations are the fundamental operations in a GraphQL API. A query is used to read or retrieve data, while a mutation is used to write, modify, or post data. Each operation is a string that the GraphQL server can parse and respond to with data in a specific structure, generally in JSON format.

Consider a query or mutation as a method within your source code - it accepts arguments, performs a function, and then returns a response in a predictable format.

	query customers {
		customer {
			id
			firstName
			lastName
		}
	}

	{
		"data":
            "customers": {
                [
                    {
                        "id": "WAz8eIbvDR60rouK",
                        "firstName": "Esther",
                        "lastName": "Mude"
                    },
                    {
                        "id": "WAz8eIbvDR60rouK",
                        "firstName": "Jens-Peter",
                        "lastName": "Misicher"
                    }
                    ...
                ]
            }
	}

	mutation createCustomer($firstName: String!, $lastName: String!) {
		createCustomer(firstName: $firstName, lastName: $lastName) {
			id
			firstName
			lastName
		}
	}

	{
		"data": {
            "createCustomer": {
                "id": "WAz8eIbvDR60rouK",
                "firstName": "Esther",
                "lastName": "Mude"
            }
        }
	}

Entity Representation

Guides

Resources