API-documentatieTechnische documentatie

API-documentatie op basis van je endpointbeschrijvingen

Meestal klaar in 15 minutenRevisies inbegrepenKwaliteitscontrole
Pakketten
BetaalbeschermingDetails
  • Revisies binnen het pakket zijn gratis.
  • Reageer je niet binnen 3 dagen na levering, dan wordt het werk automatisch goedgekeurd.

Het geld wordt bij betaling gereserveerd en pas vrijgegeven als je het werk goedkeurt.

API-documentatie op basis van je endpointbeschrijvingen

Voorbeeldresultaat

Voorbeeld voor het pakket Standaard

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

De klant en alle details zijn verzonnen.

Over deze dienst

Ontwikkelaars beoordelen een API binnen minuten op de documentatie: als authenticatie of het eerste verzoek niet werkt, haken ze af. Wij schrijven API-referentie en gidsen op basis van je endpointbeschrijvingen, OpenAPI-bestand of codevoorbeelden: authenticatie, basis-URL's, elk endpoint met parameters, voorbeelden van verzoeken en antwoorden, foutcodes, limieten en paginering. Een snelstart laat in een paar stappen de eerste geslaagde aanroep zien.

Wat is inbegrepen

  • Wat je krijgtAPI-documentatie als Markdown met codeblokken, klaar voor ReadMe, GitBook, Docusaurus of je repository. Wij schrijven op basis van wat je ons stuurt en roepen je API zelf niet aan.
  • SnelstartVan API-sleutel tot eerste aanroep
  • EndpointreferentieParameters, types, voorbeelden
  • Fouten en limietenCodes, betekenis, advies om opnieuw te proberen
  • CodevoorbeeldencURL plus een taal naar keuze
  • Consistente termenDezelfde namen als in je schema

Hoe het werkt

  1. 1
    BriefingJe plakt of voegt endpoints en voorbeelden toe
  2. 2
    Opzet en schrijvenWij schrijven de referentie en gidsen
  3. 3
    LeveringJe ontvangt Markdown klaar voor publicatie

Wat we van je nodig hebben

Endpointbeschrijvingen of een OpenAPI- of Postman-bestand als geplakte tekst, details over authenticatie, voorbeeldverzoeken en -antwoorden, foutcodes en wie je API-gebruikers zijn.

We vragen je:

  • Wat doet de API en wie gebruikt hem?
  • Hoe werkt de authenticatie?
  • Welke taal moeten de codevoorbeelden gebruiken naast cURL?
  • Waar wordt de documentatie gepubliceerd?

Pakketten vergelijken

PakkettenBasis€ 17Standaard€ 35Premium€ 70
Wat is inbegrepenSnelstart en maximaal 5 endpointsTot 20 endpoints met gidsenTot 50 endpoints, volledige documentatie
Levertijd1 dag3 dagen5 dagen
Revisies123
Lengtetot 2.000 woordentot 6.000 woordentot 14.000 woorden
Endpointstot 5tot 20tot 50
Talen van de codevoorbeeldencURLcURL + 1cURL + 2
Bestellen BasisBestellen StandaardBestellen Premium

Betaalbescherming

Je betaalt bij het bestellen, maar het geld wordt alleen vrijgegeven voor goedgekeurd werk.

  • Vaste prijsDe prijs van het pakket verandert niet meer nadat je hebt betaald.
  • Het geld wordt gereserveerdBij betaling wordt het bedrag alleen gereserveerd. Het gaat pas naar de dienst als je het werk goedkeurt.
  • Gecontroleerd vóór leveringElk resultaat doorloopt een kwaliteitscontrole voordat het bij jou komt, en je ziet het op de bestelpagina voordat je het goedkeurt.
  • Gratis revisiesVraag wijzigingen binnen je briefing aan, zo vaak als het pakket toestaat.
  • Goedkeuring na 3 dagenKeur je het werk binnen 3 dagen na levering niet goed en vraag je ook geen wijzigingen, dan wordt het automatisch goedgekeurd. Schrijf je na levering in de chat van de bestelling, dan wacht de bestelling; zodra we hebben geantwoord, kunnen we de 3 dagen opnieuw laten ingaan en melden we dat in de chat.
  • Opnieuw doen of volledige terugbetalingPast het resultaat niet bij je briefing en hebben de revisies dat niet opgelost, of duurt het werk meer dan twee keer zo lang als de levertijd, schrijf dan in de chat van de bestelling: we doen het werk opnieuw of betalen het volledige bedrag terug.
Hoe het werkt →

Vragen en antwoorden

Kunnen jullie werken vanuit onze OpenAPI-specificatie?

Ja, plak de YAML of JSON in de briefing. Wij maken van de beschrijvingen leesbare referentiepagina's en vullen hiaten aan die je aanwijst.

Testen jullie de voorbeelden?

Wij roepen je API niet aan. Voorbeelden worden opgebouwd uit je voorbeelden van verzoeken en antwoorden, dus voer ze eenmaal uit voordat je publiceert.

Schrijven jullie SDK-documentatie?

Ja, als je de methodehandtekeningen en gebruiksvoorbeelden stuurt. Elke SDK telt mee in het volume van het pakket.

Staat je antwoord er niet bij?

Pakketten