Dokumentacja APIDokumentacja techniczna

Dokumentacja API na podstawie opisów twoich endpointów

Zwykle gotowe w ok. 15 minutPoprawki w cenieKontrola jakości
Pakiety
Ochrona płatnościSzczegóły
  • Poprawki w ramach pakietu są bezpłatne.
  • Jeśli nie odpowiesz w ciągu 3 dni od dostarczenia pracy, zostanie ona zaakceptowana automatycznie.

Pieniądze są rezerwowane w chwili płatności i przekazywane dopiero po akceptacji pracy.

Dokumentacja API na podstawie opisów twoich endpointów

Przykładowy rezultat

Przykład dla pakietu Standard

Dokumentacja API: API do śledzenia przesyłek dla sklepów internetowych

Szybki start

  1. Pobierz klucz API w Dashboard → Settings → API keys.
  2. Wysyłaj każde zapytanie z nagłówkiem Authorization: Bearer <your_key>.
  3. Bazowy URL: https://api.trackpoint.example/v1

Pobranie przesyłki

GET /shipments/{tracking_number}

Zwraca bieżący status i historię zdarzeń jednej paczki.

ParametrGdzieWymaganyOpis
tracking_numberpathtakNumer przesyłki przewoźnika, 8–30 znaków
langquerynieJęzyk tekstów statusu: en, de, fr. Domyślnie en

Przykładowe zapytanie

curl https://api.trackpoint.example/v1/shipments/JD014600006281 \
  -H "Authorization: Bearer sk_test_51x..."

Przykładowa odpowiedź (200)

{
  "tracking_number": "JD014600006281",
  "status": "in_transit",
  "estimated_delivery": "2026-11-19",
  "events": [
    {"time": "2026-11-16T08:42:00Z", "location": "Leipzig hub", "status": "in_transit"}
  ]
}

Błędy

KodZnaczenieCo zrobić
401Brak klucza API lub błędny kluczSprawdź nagłówek Authorization
404Nie znaleziono numeru przesyłkiPrzewoźnik może potrzebować do 2 godzin na zarejestrowanie nowej paczki
429Ponad 100 zapytań na minutęOdczekaj czas podany w nagłówku Retry-After

Przekazano

Dokumentację wszystkich 14 endpointów w Markdownie, gotową na stronę dokumentacji klienta, oraz listę 3 miejsc, w których API działało inaczej niż w opisach, przekazaną programistom.

Klient: Trackpoint, startup, którego REST API pozwala sklepom internetowym pokazywać status paczki; programiści przysłali krótkie opisy 14 endpointów i zestaw przykładowych zapytań Zadanie: szybki start i opis endpointów, z którymi programista poradzi sobie w 15 minut; poniżej fragment

Klient i wszystkie dane są wymyślone.

O usłudze

Programiści oceniają API po dokumentacji w ciągu kilku minut: jeśli uwierzytelnianie lub pierwsze zapytanie nie działa, odchodzą. Piszemy dokumentację referencyjną API i poradniki na podstawie opisów endpointów, pliku OpenAPI lub przykładów kodu: uwierzytelnianie, bazowe adresy URL, każdy endpoint z parametrami, przykłady zapytań i odpowiedzi, kody błędów, limity zapytań i paginacja. Szybki start pokazuje pierwsze udane wywołanie w kilku krokach.

Co obejmuje usługa

  • Co otrzymujeszDokumentacja API w Markdownie z blokami kodu, gotowa dla ReadMe, GitBook, Docusaurus lub twojego repozytorium. Piszemy na podstawie przesłanych materiałów i sami nie wywołujemy twojego API.
  • Szybki startOd klucza API do pierwszego wywołania
  • Dokumentacja endpointówParametry, typy, przykłady
  • Błędy i limityKody, znaczenia, wskazówki dotyczące ponowień
  • Przykłady koducURL plus jeden wybrany język
  • Spójne nazewnictwoTe same nazwy co w twoim schemacie

Jak to działa

  1. 1
    BriefTy wklejasz lub załączasz endpointy i przykłady
  2. 2
    Struktura i pisaniePiszemy dokumentację referencyjną i poradniki
  3. 3
    DostarczenieOtrzymujesz Markdown gotowy do publikacji

Czego potrzebujemy od Ciebie

Opisy endpointów lub plik OpenAPI albo Postman wklejony jako tekst, szczegóły uwierzytelniania, przykładowe zapytania i odpowiedzi, kody błędów oraz informację, kim są użytkownicy twojego API.

Zapytamy Cię:

  • Co robi API i kto z niego korzysta?
  • Jak działa uwierzytelnianie?
  • W jakim języku oprócz cURL mają być przykłady kodu?
  • Gdzie zostanie opublikowana dokumentacja?

Porównaj pakiety

PakietyPodstawowy72 złStandard147 złPremium298 zł
Co obejmuje usługaSzybki start i do 5 endpointówDo 20 endpointów z poradnikamiDo 50 endpointów, pełna dokumentacja
Termin1 dzień3 dni5 dni
Poprawki123
Długośćdo 2000 słówdo 6000 słówdo 14 000 słów
Endpointydo 5do 20do 50
Języki przykładów koducURLcURL + 1cURL + 2
Zamów PodstawowyZamów StandardZamów Premium

Ochrona płatności

Płacisz przy składaniu zamówienia, ale pieniądze są przekazywane tylko za zaakceptowaną pracę.

  • Stała cenaCena pakietu nie zmienia się po zapłacie.
  • Pieniądze są zarezerwowanePrzy płatności kwota jest tylko rezerwowana. Serwis otrzymuje ją dopiero po akceptacji pracy.
  • Sprawdzone przed dostarczeniemKażdy wynik przechodzi kontrolę jakości, zanim do Ciebie trafi, a przed akceptacją widzisz go na stronie zamówienia.
  • Bezpłatne poprawkiProś o poprawki w ramach briefu tyle razy, ile przewiduje pakiet.
  • Akceptacja po 3 dniachJeśli w ciągu 3 dni od dostarczenia pracy ani jej nie zaakceptujesz, ani nie poprosisz o poprawki, zostanie zaakceptowana automatycznie. Jeśli po dostarczeniu napiszesz na czacie zamówienia, zamówienie czeka; po naszej odpowiedzi możemy ponownie uruchomić odliczanie 3 dni i poinformujemy o tym na czacie.
  • Ponowne wykonanie lub pełny zwrot pieniędzyJeśli wynik nie odpowiada Twojemu briefowi, a poprawki tego nie naprawiły, lub praca trwa ponad dwa razy dłużej niż termin, napisz na czacie zamówienia: wykonamy pracę ponownie albo zwrócimy całą płatność.
Jak to działa →

Pytania i odpowiedzi

Czy możecie pracować na podstawie naszej specyfikacji OpenAPI?

Tak, wklej YAML lub JSON do briefu. Zamienimy jej opisy w czytelne strony referencyjne i uzupełnimy wskazane przez ciebie luki.

Czy przetestujecie przykłady?

Nie wywołujemy twojego API. Przykłady powstają z twoich próbek zapytań i odpowiedzi, więc uruchom je raz przed publikacją.

Czy piszecie dokumentację SDK?

Tak, jeśli prześlesz sygnatury metod i przykłady użycia. Każde SDK wlicza się do objętości pakietu.

Nie ma tu odpowiedzi?

Pakiety