API dokümantasyonuTeknik Dokümantasyon

Uç nokta açıklamalarınızdan API dokümantasyonu

Genellikle 15 dakika içinde hazırRevizyonlar dahilKalite kontrolü
Paketler
Ödeme korumasıAyrıntılar
  • Paket kapsamındaki revizyonlar ücretsizdir.
  • Teslimattan sonraki 3 gün içinde yanıt vermezseniz iş otomatik olarak onaylanır.

Para, ödeme yaptığınızda bloke edilir ve yalnızca işi onayladığınızda aktarılır.

Uç nokta açıklamalarınızdan API dokümantasyonu

Örnek sonuç

Standart paket için örnek

API documentation: a parcel tracking API for online stores

Quick start

  1. Get your API key in Dashboard → Settings → API keys.
  2. Send every request with the header Authorization: Bearer <your_key>.
  3. Base URL: https://api.trackpoint.example/v1

Get a shipment

GET /shipments/{tracking_number}

Returns the current status and event history of one parcel.

ParameterInRequiredDescription
tracking_numberpathyesCarrier tracking number, 8–30 characters
langquerynoLanguage of status texts: en, de, fr. Default: en

Example request

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

Example response (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"}
  ]
}

Errors

CodeMeaningWhat to do
401Missing or wrong API keyCheck the Authorization header
404Tracking number not foundCarriers can take up to 2 hours to register a new parcel
429More than 100 requests a minuteWait for the time given in the Retry-After header

Delivered

Docs for all 14 endpoints in Markdown, ready for the client's docs site, and a list of 3 places where the API behaved differently from the descriptions, sent to the developers.

Client: Trackpoint, a startup whose REST API lets online stores show parcel status; the developers sent short descriptions of 14 endpoints and a set of sample requests Task: a quick start and an endpoint reference a developer can follow in 15 minutes; an excerpt is below

Müşteri ve tüm ayrıntılar kurgusaldır.

Bu hizmet hakkında

Geliştiriciler bir API'yi dakikalar içinde dokümantasyonuna bakarak değerlendirir: kimlik doğrulama veya ilk istek çalışmazsa giderler. Uç nokta açıklamalarınızdan, OpenAPI dosyanızdan veya kod örneklerinizden API referansı ve rehberler yazıyoruz: kimlik doğrulama, temel URL'ler, parametreleri olan her uç nokta, istek ve yanıt örnekleri, hata kodları, istek sınırları ve sayfalama. Hızlı başlangıç, ilk başarılı çağrıyı birkaç adımda gösterir.

Neler dahil

  • Neler alırsınızReadMe, GitBook, Docusaurus veya deponuza hazır, kod bloklu Markdown olarak API dokümantasyonu. Gönderdiklerinizden yazarız, API'nize kendimiz çağrı yapmayız.
  • Hızlı başlangıçAPI anahtarından ilk çağrıya
  • Uç nokta referansıParametreler, türler, örnekler
  • Hatalar ve sınırlarKodlar, anlamları, yeniden deneme önerisi
  • Kod örneklericURL ve seçeceğiniz bir dil
  • Tutarlı terimlerŞemanızdaki adlarla aynı

Nasıl çalışır

  1. 1
    BrifUç noktaları ve örnekleri yapıştırır veya eklersiniz
  2. 2
    Yapı ve yazımReferansı ve rehberleri yazarız
  3. 3
    TeslimatYayına hazır Markdown alırsınız

Sizden neler gerekiyor

Metin olarak yapıştırılmış uç nokta açıklamaları veya bir OpenAPI ya da Postman dosyası, kimlik doğrulama ayrıntıları, örnek istekler ve yanıtlar, hata kodları ve API kullanıcılarınızın kim olduğu.

Size soracaklarımız:

  • API ne yapıyor ve kimler kullanıyor?
  • Kimlik doğrulama nasıl çalışıyor?
  • cURL dışında kod örnekleri hangi dilde olsun?
  • Dokümanlar nerede yayımlanacak?

Paketleri karşılaştırın

PaketlerTemel$19Standart$39Premium$79
Neler dahilHızlı başlangıç ve 5 uç noktaya kadarRehberli 20 uç noktaya kadar50 uç noktaya kadar tam dokümantasyon
Teslim süresi1 gün3 gün5 gün
Revizyonlar123
Uzunluken fazla 2.000 kelimeen fazla 6.000 kelimeen fazla 14.000 kelime
Uç noktalaren fazla 5en fazla 20en fazla 50
Kod örneği dillericURLcURL + 1cURL + 2
Sipariş ver TemelSipariş ver StandartSipariş ver Premium

Ödeme koruması

Sipariş verirken ödersiniz, ancak para yalnızca onaylanan iş için aktarılır.

  • Sabit fiyatPaket fiyatı, ödeme yaptıktan sonra değişmez.
  • Para bloke edilirÖdeme yaptığınızda tutar yalnızca bloke edilir. İşi onayladığınızda hizmete aktarılır.
  • Teslimattan önce kontrolHer sonuç size ulaşmadan önce kalite kontrolünden geçer ve onaylamadan önce sipariş sayfasında görürsünüz.
  • Ücretsiz revizyonlarBrifiniz kapsamında, paketin izin verdiği sayıda değişiklik isteyin.
  • 3 gün sonra onayTeslimattan sonraki 3 gün içinde işi onaylamaz veya değişiklik istemezseniz iş otomatik olarak onaylanır. Teslimattan sonra sipariş sohbetine yazarsanız sipariş bekletilir; yanıt verdikten sonra 3 günlük süreyi yeniden başlatabiliriz ve bunu sohbette bildiririz.
  • Yeniden yapım veya tam iadeSonuç brifinize uymuyorsa ve revizyonlar sorunu çözmediyse ya da iş teslim süresinin iki katından uzun sürerse sipariş sohbetine yazın: işi yeniden yaparız veya ödemenin tamamını iade ederiz.
Nasıl çalışır →

Sorular ve yanıtlar

OpenAPI belirtimimizden çalışabilir misiniz?

Evet, YAML veya JSON'u brife yapıştırın. Açıklamalarını okunabilir referans sayfalarına dönüştürür, belirttiğiniz boşlukları dolduruz.

Örnekleri test ediyor musunuz?

API'nize çağrı yapmayız. Örnekler istek ve yanıt örneklerinizden oluşturulur; yayımlamadan önce bir kez çalıştırın.

SDK dokümanları yazıyor musunuz?

Evet, metot imzalarını ve kullanım örneklerini gönderirseniz. Her SDK'yı paket hacminin bir parçası sayın.

Yanıtınızı bulamadınız mı?

Paketler