Getting Started

Getting started with the BaseCMS GraphQL API

Welcome!

Welcome to the BaseCMS Developer program!

About the API

The BaseCMS API can be accessed using GraphQL -- an abstract query language for retrieving data in a standard format, originally developed by the team at Facebook.

GraphQL Playground can be used as a locally installed API client, or the GraphQL connection can be accessed programmatically in most languages with the use of a client. For more information about using GraphQL, check out the docs.

You'll need the following information to read data from the API:

• An API URL

• A Tenant Key

• An active Base user with permission to read data

If you're missing any of this, please reach out to [e-mail] and we'd be happy to help you out!

Connecting to the API

Your GraphQL production and staging URLs will be provided, and should look something like this: <identifier>.graphql.base.parameter1.com or <identifier>.graphql.base-staging.parameter1.com. The API must be accessed via HTTP/S on port 443.

Requests to the GraphQL API must include the x-tenant-key header for the Base instance in question: such as x-tenant-key: my-base-instance-id.

Once connected, you can see available query documentation and schema definitions within the GraphQL Playground application.

For more in-depth information, see the topics on Querying Data and Modifying Data.