Overview

Ginto provides a **GraphQL API** to query and access the accessibility data in Ginto. With GraphQL, clients can request exactly the fields they need by sending a query document in the request body.

Usage

Endpoint

Send GraphQL requests to:

https://api.ginto.guide/graphql

Authorization

<aside> 💡 Contact [email protected] to get an API key for API authorization

</aside>

The API is protected and can only be accessed when the request is authenticated with an API key. The API key must be provided with each request as a Bearer Token in the Authorization header:

Authorization: Bearer {apiKey}

Request

GraphQL queries can be sent over HTTP using a standard POST request. The query defines which data is return as response (see Queries and Use Cases and Examples for more concrete examples). It is sent in the request body as JSON with the following structure:

{
  "query": "{ allEntries(first: 10) { nodes { id name } } }",
  "variables": {}
}

The endpoint URL should be set to https://api.ginto.guide/graphql, and the request must include:

• Content-Type: application/json header
• Accept: application/graphql-response+json, application/json header
• Authorization: Bearer {apiKey} header with your API key
• Optional: Accept-Language header to specify the desired language (e.g., de, en, fr, or it)

The server responds with JSON containing a data object for successful operations. If something goes wrong, the response can contain an errors array (and data may be null or partially present).

• Beispiel mit cURL