graphapi Documentation

# Quickstart Guide

This guide provides the steps you need to create a scalable data backend running on Amazon Web Services (AWS) (opens new window) powered by our powerful cloud automation engine.

Our graphapi backend includes the following:

By the end of this guide, you'll have a fully functioning data backend with data management capabilities and a GraphQL interface optionally protected by a user authentication layer.

# Step 1 - Sign up

Before getting started, create a verified graphapi account that allows you to manage an existing graphapi workspace or create a new one.

TIP

Take a shortcut at https://my.graphapi.com/signup (opens new window)

# Step 2 - Create a workspace

After signing up, a user must create a workspace. The graphapi workspace enables knowledge workers and developers to collaborate seamlessly.

TIP

Create multiple workspaces to separate projects, teams, or billing.

Further reading: Workspaces

# Step 3 - Complete wizard

When you arrive on your workspace dashboard, start the setup wizard by clicking on the Create graphapi widget. The wizard guides you through setting up and publishing a graphapi.

Workspace Dashboard

Further reading: Setup Wizard

# Step 4 - Invite collaborators

To invite collaborators to your workspace, open the User management dashboard and follow these steps:

  1. Click the Invite user button.
  2. Enter the collaborators' email address.
  3. Select the collaborators' role.
  4. Click the Invite button.

Your collaborators will receive an email with instructions on creating their graphapi account and start working with you.

Note: The first five collaborators are free of charge.

# Step 5 - Upload and manage data

After a graphapi is published, collaborators can input and manage their data in a simple-to-use data explorer.

To upload data, follow these steps:

  1. Open the API's data menu.
  2. Create a data admin user for APIs protected with authentication.
  3. Select the model type for which you want to upload data.
  4. Click the Browse button and select a CSV file in the FileOpen dialog or drag and drop a CSV file to the file upload bar.
  5. When the CSV contains data for all required fields, the data manager will upload it to the database.

Once your data is uploaded, you can use the data explorer to manage it. You can view and edit records and filter and export data if needed.

# Step 6 - Integrate GraphQL API

Each graphapi comes with a GraphQL interface providing programmatic access to your data. GraphQL works with a single endpoint to retrieve existing data using queries and modify existing data using mutations. It also supports real-time updates and subscriptions, making building responsive and engaging user interfaces much simpler.

GraphQL Explorer

Developers can find the GraphQL endpoint on the graphapi settings page. Use your framework of choice to integrate with your app: GraphQL Tools Overview (opens new window)

Further reading: Integration

TIP

Generate typescript definitions for your GraphQL-based graphapi.

Follow our Github README (opens new window)

Further reading: What is GraphQL? (opens new window)

← Setup Wizard →