Files
kan/apps/docs/api-reference/introduction.mdx
2024-12-28 23:20:24 +00:00

34 lines
1000 B
Plaintext

---
title: "Introduction"
description: "Learn how to integrate with Kan's REST API."
---
## Base URL
```
https://kanbn.com/api/v1
```
## Authentication
Most endpoints require authentication using Bearer tokens. You can get this from the `sb-kanbn-auth-token.0` cookie in your browser. Include this token in the Authorization header of each request.
```
Authorization: Bearer 123456789
```
## Response codes
Kan uses standard HTTP codes to indicate the success or failure of your requests.
In general, `2xx` HTTP codes correspond to success, `4xx` codes are for user-related failures, and `5xx` codes are for infrastructure issues.
| Status | Description |
| ------ | ------------------------------- |
| `200` | Success |
| `400` | Invalid parameters |
| `401` | Missing token |
| `403` | Invalid token |
| `404` | Resource not found |
| `500` | Error with Kan's infrastructure |