Documentation
Comprehensive guides, API references, and resources to help you build with Sprint Simple
Introduction
Welcome to the Sprint Simple documentation. This comprehensive guide will help you understand our platform, APIs, and how to integrate our services into your applications. Whether you're building a new project or enhancing an existing one, our documentation provides everything you need to get started.
Sprint Simple provides a suite of tools and services designed to accelerate your development process and enhance your applications with cutting-edge technology. Our platform is built with flexibility and scalability in mind, allowing you to focus on creating value for your users.
Quick Start Guide
Get up and running with Sprint Simple in minutes. Follow these steps to integrate our platform into your application:
Create an Account
Sign up for a Sprint Simple account and create your first project in our dashboard.
Install the SDK
Add our SDK to your project using npm, yarn, or include it directly in your HTML.
Integrate & Deploy
Follow our integration guide to connect your application and deploy your first feature.
Installation
npm install @sprint-simple/sdkBasic Usage
import { SprintSimple } from '@sprint-simple/sdk';
// Initialize the SDK with your API key
const client = new SprintSimple({
apiKey: 'your_api_key_here',
environment: 'production' // or 'development'
});
// Make your first API call
async function getStarted() {
try {
const result = await client.projects.create({
name: 'My First Project',
description: 'A project created with the Sprint Simple SDK'
});
console.log('Project created:', result);
} catch (error) {
console.error('Error creating project:', error);
}
}Core Concepts
Understanding the core concepts of Sprint Simple will help you make the most of our platform. Here are the key components and how they work together:
Projects
Projects are the top-level organizational unit in Sprint Simple. Each project has its own settings, API keys, and resources.
Environments
Each project can have multiple environments (development, staging, production) with isolated resources and configurations.
API Keys
API keys authenticate your requests to the Sprint Simple API. Different key types provide different levels of access.
Webhooks
Webhooks allow your application to receive real-time notifications about events that occur in your Sprint Simple project.
API Authentication
All requests to the Sprint Simple API must be authenticated using your API key. We support several authentication methods to suit different use cases.
Authentication Methods
Bearer Token
The recommended way to authenticate API requests is using the Bearer token scheme in the Authorization header.
curl https://api.sprintsimple.com/v1/projects \ -H 'Authorization: Bearer your_api_key_here'Query Parameter
For testing or simple use cases, you can pass your API key as a query parameter.
curl https://api.sprintsimple.com/v1/projects?api_key=your_api_key_hereSecurity Note
Never expose your API keys in client-side code or public repositories. Always use environment variables or secure secret management solutions to store your keys.