Introduction

This page is actively being updated. If you feel that some pages require improvements, you may email us at [e-mail]

👋 Welcome to Warpgate API docs!

Warpgate API uses GraphQL where it lets developers define the data they want to retrieve in a single call.

As developers, we used to be frustrated at how long it took to complete every software development project we do. We would repetitively build the same pagination, search, CRUD and reporting functions.

We created Warpgate API to let us build web apps in a faster, time-efficient and scalable way. This lets us have more time on developing the product than writing repetitive code for administrative tasks.

What do I need to know?

A basic understanding of GraphQL would suffice in getting started. If you don't have experience in GraphQL, it's totally fine. Your web application will still communicate using standard HTTP requests. The only difference over standard REST API is that:

• There is only one endpoint /graphql

• Only two body parameters are accepted { query, variables }

Quick guide

A barebones GraphQL query in Node.js would look something like this:

async function callQuery(query, variables) {
  const res = await fetch({
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${WARPGATE_API_TOKEN}`,
    },
    body: JSON.stringify({
      query,
      variables
    }),
  })
  
  return res.json()
}

If you notice, there is a query parameter in the callQuery function. The values you pass there are your actual GraphQL query (which is what our documentation will mostly contain).

The parameters inside the GraphQL queries can be defined as a variable which should be included when you call the callQuery function in your web application.

const REGISTER = `
mutation Register($input: LoginInput!) {
  tenant {
    register(input: $input) {
      id
      username
      insertedAt
      updatedAt
    }
  }
}
`

Finally, to do a GraphQL call:

import './queries/REGISTER'
import './callQuery'

const { data, errors } = await callQuery(REGISTER, {
  input: {
    username: '[e-mail]',
    password: 'password'
  }
})

The getting started section will provide some utility functions that you can include in your application.