Skip to main content

GraphQL API 🔌

The Abowire GraphQL API to make helps you integrate in a faster and more reliable way. You can request exactly what you need and get predictable results.

GraphQL endpoint​

https://graphql.abowire.com

What is GraphQL?​

GraphQL is a "query language for APIs". GraphQL provides a complete and understandable description of the data in our API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.

Request:​

query {
  customers {
    items {
      id
      name
    }
  }
}

Response:​

{
  "customers": {
    "items": [
      {
        "id": "customer_1",
        "name": "Jane Doe"
      }
    ]
  }
}

Get many resources in a single request​

While typical REST APIs require loading from multiple URLs, GraphQL APIs get all the data your app needs in a single request. Apps using GraphQL can be quick even on slow mobile network connections.

Request:​

query {
  customers {
    items {
      id
      name
    }
  }

  invoices {
    items {
      id
      number
      customer {
        name
      }
    }
  }

  transactions {
    items {
      id
      amount
      customer {
        name
      }
    }
  }
}

Response:​

{
  "customers": {
    "items": [
      {
        "id": "customer_1",
        "name": "Jane Doe"
      }
    ]
  },
  "invoices": {
    "items": [
      {
        "id": "invoice_1",
        "number": "2023-08-01"
      }
    ]
  },
  "transactions": {
    "items": [
      {
        "id": "transaction_1",
        "amount": "2000"
      }
    ]
  }
}

GraphQL Client​

You can communicate with our GraphQL API simply by sending a HTTP POST request to our GraphQL endpoint, passing the GraphQL query as the query field in a JSON payload.

Since a GraphQL API has more underlying structure than a REST API, there are more powerful clients which can automatically handle batching, caching, and other features.

You can find a list of clients here

Abowire SDK​

Abowire provides a Javascript SDK based on the Apollo GraphQL client. This SDK contains all required libraries, which come pre-configured to authenticate and execute queries against our servers.

Our SDK works both in the frontend and in the backend (NodeJS), and comes together with its Typescript types.

You can learn more about our Javascript SDK here