Our APIs

Transitioning from REST/RPC/JSON to GraphQL: A Modern API Approach

At New Spark, we’ve evolved our API architecture to better serve developers and enhance the flexibility of our platform. While our legacy REST/RPC/JSON API provided foundational capabilities, we’ve introduced a modern GraphQL API to offer more efficient, precise, and developer-friendly interactions.

🛠️ Legacy REST/RPC/JSON API: The Traditional Approach

Our previous API utilized RESTful principles combined with RPC (Remote Procedure Calls) over JSON. This approach required multiple endpoints for different resources, leading to potential over-fetching or under-fetching of data. For instance, retrieving a asset’s details and its associated comments might necessitate separate requests, which could be inefficient and cumbersome for developers.

🚀 Introducing the GraphQL API: A Modern Solution

To address the limitations of the traditional API, we’ve adopted GraphQL, a query language for APIs that allows clients to request exactly the data they need. This shift enables more efficient data retrieval and a more streamlined development experience.

Key Benefits of Our GraphQL API:

  • Single Endpoint Access: All data can be accessed through a single /graphql endpoint, simplifying the API structure.
  • Precise Data Fetching: Clients can specify exactly which fields they need, reducing unnecessary data transfer.
  • Nested Queries: Retrieve related data in a single request, eliminating the need for multiple API calls.
  • Strongly Typed Schema: The schema defines the structure of the API, enabling better validation and introspection.
  • Versionless Evolution: GraphQL APIs can evolve without versioning, as clients request only the data they need.

đź”— Explore the GraphQL API

To interact with our GraphQL API, you can use the following endpoint:

GraphQL Endpoint:
https://v7.newspark.ca/gql/graphiql

This endpoint supports both GET and POST methods, allowing you to execute queries and mutations as needed.

By transitioning to GraphQL, we aim to provide a more efficient and flexible API that meets the evolving needs of developers. We encourage you to explore our new GraphQL API and leverage its capabilities to build more dynamic and responsive applications.