GraphQL API: Getting Started
This GraphQL API is used extensively by the Paminga platform itself. More than 95% of all data retrieval and manipulation in the platform go through this API.
If you can do it in the platform, it's very likely you can do it via this API.
If you're not familiar with GraphQL, you can learn about GraphQL here
Ongoing Development
This GraphQL API is under constant development: it is how we expose new functionality in the platform.
Breaking changes are possible. We attempt to leverage deprecation, but breaking change can happen rarely.
Strong Typing
A GraphQL API is strongly typed without exception.
All available types are defined in the schema, which is used to drive autocompletion and error checking in your developer tools.
You'll find this to be very helpful: GraphQL's strong typing makes development faster.
Endpoint
Paminga's GraphQL API has a single endpoint for all requests.
Endpoint: https://api.paminga.com/graphql
Client
All modern developer tools/languages are capable of working with a GraphQL API.
A GraphQL API exposes a "schema" that makes clear all possible operations, and all possible/required inputs and outputs. These docs are auto-generated by "introspecting" that schema.
GraphQL developer tools leverage the schema, providing autocompletion and real-time syntax highlighting of errors.
Altair GraphQL Client
Altair is a free, downloadable app (Windows, Mac, Linux, browser) that can aid you in getting up to speed quickly.
- All types and operations exposed (via the schema) in the "Docs" section
- Click to add a query or mutation to try out
- Autocompletion and error highlighting
- Run live queries
Feel free to use any GraphQL tooling you choose. Altair is only a suggestion.
Sandbox Instance
If your plan includes API access, a sandbox instance of Paminga can be made available to you at no additional cost.
Please email support@paminga.com to request a sandbox instance.
Authentication
You may authenticate via a Bearer Token, OAuth, or Basic Auth.
Bearer Token
To get started quickly, you can copy your JWT (Javascript Web Token) from Chrome (or other) developer tools.
Your JWT can be found in Local Storage using the key: NRJWT.
OAuth
When moving to production, OAuth may be the preferred authentication mechanism.
If you have a Paminga user account with API access, you may create an oAuth app here.
Responses
All GraphQL responses are in JSON format.
A JSON response is nested in the exact shape that you requested in your query or mutation.
Support
Paminga is happy to assist as you get up to speed with this GraphQL API.
Simply reach out to support@paminga.com. We're happy to bring a Paminga engineer to a screen share to get you oriented and developing quickly.
You'll find that we will always remain accessible and available to help with questions.
Rate & Complexity Limiting
Paminga reserves the right to adjust rate limiting settings as needed to protect the integrity of this API.
GraphQL makes it possible to request deeply nested data. In extreme cases, this can lead to performance issues. Paminga reserves the right to adjust limitations related to allowed levels of query complexity.
