The Greenspark Projects SDK provides access to the Greenspark Projects API from applications running on a server or in a browser.
See the @greenspark/projects
API docs for details.
Node 16 or higher.
Install the package with:
npm install @getgreenspark/projects --save
The SDK use the production
environment by default. You only need to provide your API key.
const projectsApi = new ProjectsApi({apiKey: "<YOUR_API_KEY>"})
The SDK use the production
environment by default. You can use the sandbox
environment for testing and development by providing the sandbox
environment basePath
and your API key.
const projectsApi = new ProjectsApi({basePath: "https://sandbox.getgreenspark.com", apiKey: "<YOUR_API_KEY>"})
The SDK needs to be configured with your Greenspark API key, which is available in the Greenspark Dashboard.
import {Project, ProjectsApi} from "@getgreenspark/projects";
const projectsApi = new ProjectsApi({apiKey: "<YOUR_API_KEY>"})
const {data}: Project[] = await projectsApi.getProjects()
console.log(data);