Odniesienie API

SprintFlint zapewnia REST API do programowego dostępu do twoich projektów, sprintów i problemów. Użyj go do integracji z Zapier, niestandardowymi skryptami lub własnymi aplikacjami.

Uwierzytelnianie

Wszystkie żądania API wymagają uwierzytelnienia przy użyciu tokena okaziciela.

Generowanie tokena API

Kliknij swój awatar na pasku bocznym
Przejdź do „Mój profil”
Przewiń do sekcji „Token API”.
Kliknij „Wygeneruj token”
Skopiuj i bezpiecznie przechowuj swój token

Bezpieczeństwo tokenów - Twój token API zapewnia taki sam dostęp, jak Twoje zalogowane konto. Zachowaj to w tajemnicy i nigdy nie przekazuj tego kontroli wersji.

Korzystanie z tokena

Dołącz token do Authorization nagłówek każdego żądania:

Authorization: Bearer your-api-token-here

Przykład z cURL:

curl -H "Authorization: Bearer your-api-token" \
  https://sprintflint.com/api/v1/projects

Bazowy adres URL

https://sprintflint.com/api/v1

Forma odpowiedzi

Wszystkie odpowiedzi są w formacie JSON. Pomyślne odpowiedzi zwracają żądane dane. Odpowiedzi na błędy obejmują komunikat o błędzie:

{
  "error": "Resource not found"
}

Dostępne punkty końcowe

Projekty

Metoda	Punkt końcowy	Opis
`GET`	`/projects`	Lista wszystkich projektów
`GET`	`/projects/:id`	Zdobądź konkretny projekt
`POST`	`/projects`	Utwórz nowy projekt
`PUT`	`/projects/:id`	Zaktualizuj projekt
`DELETE`	`/projects/:id`	Usuń projekt

Sprinty

Metoda	Punkt końcowy	Opis
`GET`	`/projects/:project_id/sprints`	Lista sprintów w projekcie
`GET`	`/projects/:project_id/sprints/:id`	Zdobądź konkretny sprint
`POST`	`/projects/:project_id/sprints`	Utwórz nowy sprint
`PUT`	`/projects/:project_id/sprints/:id`	Zaktualizuj sprint
`POST`	`/projects/:project_id/sprints/:sprint_id/activation`	Aktywuj sprint
`POST`	`/projects/:project_id/sprints/:sprint_id/completion`	Ukończ sprint
`DELETE`	`/projects/:project_id/sprints/:id`	Usuń sprint

Problemy

Metoda	Punkt końcowy	Opis
`GET`	`/projects/:project_id/issues`	Lista niezatwierdzonych problemów z zaległościami w projekcie
`POST`	`/projects/:project_id/issues`	Utwórz niezatwierdzony problem z zaległościami w projekcie
`PATCH`	`/projects/:project_id/issues/:id`	Zaktualizuj problem projektu (w tym wciągnij do sprintu)
`GET`	`/projects/:project_id/sprints/:sprint_id/issues`	Lista problemów w sprincie
`GET`	`/projects/:project_id/sprints/:sprint_id/issues/:id`	Uzyskaj konkretny problem
`POST`	`/projects/:project_id/sprints/:sprint_id/issues`	Utwórz nowy problem
`PUT`	`/projects/:project_id/sprints/:sprint_id/issues/:id`	Zaktualizuj problem
`DELETE`	`/projects/:project_id/sprints/:sprint_id/issues/:id`	Usuń problem

Komentarze

Metoda	Punkt końcowy	Opis
`GET`	`/.../issues/:issue_id/comments`	Lista komentarzy do problemu
`POST`	`/.../issues/:issue_id/comments`	Dodaj komentarz do problemu
`GET`	`/comments/:id`	Uzyskaj konkretny komentarz
`PUT`	`/comments/:id`	Zaktualizuj komentarz
`DELETE`	`/comments/:id`	Usuń komentarz

Przykład: Utwórz problem

curl -X POST \
  -H "Authorization: Bearer your-api-token" \
  -H "Content-Type: application/json" \
  -d '{
    "issue": {
      "title": "Add user authentication",
      "description": "Implement login and logout functionality",
      "story_points": 5,
      "status": "todo"
    }
  }' \
  https://sprintflint.com/api/v1/projects/1/sprints/1/issues

Przykład: aktualizacja statusu problemu

curl -X PUT \
  -H "Authorization: Bearer your-api-token" \
  -H "Content-Type: application/json" \
  -d '{
    "issue": {
      "status": "in_progress"
    }
  }' \
  https://sprintflint.com/api/v1/projects/1/sprints/1/issues/123

Limity stawek

Żądania API mają ograniczoną stawkę, aby zapobiec nadużyciom:

1000 żądań na godzinę na token API
Nagłówki limitów szybkości są uwzględniane w odpowiedziach

Interaktywna dokumentacja API

Aby uzyskać szczegółowe schematy żądań/odpowiedzi i możliwość bezpośredniego testowania punktów końcowych:

Zobacz interaktywną dokumentację API (Swagger)

Regeneracja Twojego tokena

Jeśli Twój token został naruszony:

Przejdź do „Mój profil”
Kliknij „Regeneruj token”
Stary token zostaje natychmiast unieważniony
Zaktualizuj swoje integracje o nowy token

Potrzebujesz pomocy?

Jeśli masz pytania dotyczące API lub potrzebujesz pomocy przy integracji, skontaktuj się z nami pod adresem [email protected].