This template contains a boilerplate for documentation that you can quickly use.
\nThe TeamSyncPro API provides a robust set of endpoints to facilitate project and task management for teams. This API allows you to create and manage workspaces, projects, sections, and tasks, ensuring efficient and seamless collaboration within your organization.
\nTo start using the TeamSyncPro API, you need to follow these steps:
\nAuthentication: Use the provided endpoints to sign up and log in to receive your JWT Bearer token.
\nAuthorization: All API requests must include the Bearer token in the Authorization header.
Endpoints: Utilize the various endpoints to manage users, workspaces, projects, sections, and tasks.
\nThe API has rate and usage limits.
\nThe API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
\nThe API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
\ncurl -X POST https://api.teamsyncpro.com/auth/signup \\\n -H \"Content-Type: application/json\" \\\n -d '{\"email\":\"user@example.com\", \"password\":\"yourpassword\"}'\n\nThe TeamSyncPro API uses JWT tokens for authentication. After signing up or logging in, include the Bearer token in the Authorization header of each request.
POST /auth/signup: Sign up with email
\nPOST /auth/login: Login with email
\nPOST /auth/refresh-token: Refresh Token
\nGET /auth/access-token-expired: Check if Access Token Expired
\nPOST /auth/login\nHost: api.teamsyncpro.com\nContent-Type: application/json\n{\n \"email\": \"user@example.com\",\n \"password\": \"yourpassword\"\n}\n\nStartFragment
\nInclude the received token in subsequent requests:
\nGET /user/details\nHost: api.teamsyncpro.com\nAuthorization: Bearer YOUR_JWT_TOKEN\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
\nStartFragment
\nTo ensure fair use, the TeamSyncPro API imposes rate limits on API requests.
\nThe API implements a rate limiter using Redis to store request counts. The configuration allows each IP address to make up to 100 requests per 2 minutes.
\nimport { rateLimit } from \"express-rate-limit\";\nimport { RedisStore } from \"rate-limit-redis\";\nimport redisClient from \"./redis\";\n// Create and use the rate limiter\nexport const limiter = rateLimit({\n windowMs: 2 * 60 * 1000, // 2 minutes\n max: 100, // Limit each IP to 100 requests per window (here, per 2 minutes)\n standardHeaders: true, // Return rate limit info in the RateLimit-* headers\n legacyHeaders: false, // Disable the X-RateLimit-* headers\n store: new RedisStore({\n sendCommand: (...args: string[]) => redisClient.call(...args),\n }),\n});\n\nIf the rate limit is exceeded, the API will return an HTTP 429 Too Many Requests status code.
\n{\n status:429,\n message: \"Too many requests\"\n}\n\nEach API response includes headers to help you understand your usage status:
\nAPI access rate limits apply at a per-API key basis in unit time. The limit is 300 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.
\nEach API response returns the following set of headers to help you identify your use status:
\nAn HTTP 500 response from our servers indicates there is an unexpected error. The server is usually operational within the 4 hour. If the error persists or you receive any other form of an HTTP 5XX error, contact support.