Getting Started

Getting Started with the NativeX GraphQL API

About the API

Much like the BaseCMS API the NativeX 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

  • NativeX Login Information

If you're missing any of these, please reach out to support@parameter1.com and we'd be happy to help you out!

Connecting to the API

Your API URL will be in a format similar to that of the BaseCMS API however will be in the format like the following: <tenant-key>.native-x.parameter1.com/graph. The API must be accessed via HTTP/S. Once connected, you can see available query documentation and schema definitions within the GraphQL Playground application (if using it).

Last updated