Documentazione APIDocumentazione tecnica

Documentazione API a partire dalle descrizioni dei suoi endpoint

Di solito pronto in 15 minutiRevisioni incluseControllo di qualità
Pacchetti
Pagamento protettoDettagli
  • Le revisioni previste dal pacchetto sono gratuite.
  • Se non risponde entro 3 giorni dalla consegna, il lavoro viene accettato automaticamente.

Il denaro viene riservato al momento del pagamento e sbloccato solo quando accetta il lavoro.

Documentazione API a partire dalle descrizioni dei suoi endpoint

Esempio di risultato

Esempio per il pacchetto Standard

Documentazione API: un'API di tracciamento pacchi per negozi online

Guida rapida

  1. Prendi la tua chiave API in Dashboard → Settings → API keys.
  2. Invia ogni richiesta con l'header Authorization: Bearer <your_key>.
  3. URL di base: https://api.trackpoint.example/v1

Ottenere una spedizione

GET /shipments/{tracking_number}

Restituisce lo stato attuale e lo storico degli eventi di un pacco.

ParametroDoveObbligatorioDescrizione
tracking_numberpathsìNumero di tracciamento del corriere, 8–30 caratteri
langquerynoLingua dei testi di stato: en, de, fr. Predefinita: en

Esempio di richiesta

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

Esempio di risposta (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"}
  ]
}

Errori

CodiceSignificatoCosa fare
401Chiave API mancante o errataControlla l'header Authorization
404Numero di tracciamento non trovatoIl corriere può impiegare fino a 2 ore per registrare un nuovo pacco
429Più di 100 richieste al minutoAttendi il tempo indicato nell'header Retry-After

Consegnato

La documentazione di tutti i 14 endpoint in Markdown, pronta per il sito di documentazione del cliente, e un elenco di 3 punti in cui l'API si comportava diversamente dalle descrizioni, inviato agli sviluppatori.

Cliente: Trackpoint, una startup la cui API REST permette ai negozi online di mostrare lo stato dei pacchi; gli sviluppatori hanno inviato brevi descrizioni di 14 endpoint e una raccolta di richieste di esempio Compito: una guida rapida e un riferimento degli endpoint che uno sviluppatore possa seguire in 15 minuti; sotto, un estratto

Il cliente e tutti i dati sono inventati.

Informazioni sul servizio

Gli sviluppatori giudicano un'API dalla sua documentazione in pochi minuti: se l'autenticazione o la prima richiesta non funzionano, se ne vanno. Scriviamo reference e guide dell'API a partire dalle descrizioni degli endpoint, dal file OpenAPI o da esempi di codice: autenticazione, URL di base, ogni endpoint con parametri, esempi di richiesta e risposta, codici di errore, limiti di frequenza e paginazione. Una guida rapida mostra la prima chiamata riuscita in pochi passaggi.

Cosa è incluso

  • Cosa riceveDocumentazione API in Markdown con blocchi di codice, pronta per ReadMe, GitBook, Docusaurus o il suo repository. Scriviamo da ciò che ci invia e non chiamiamo la sua API.
  • Guida rapidaDalla chiave API alla prima chiamata
  • Reference degli endpointParametri, tipi, esempi
  • Errori e limitiCodici, significati, consigli per i nuovi tentativi
  • Esempi di codicecURL più un linguaggio a sua scelta
  • Termini coerentiGli stessi nomi del suo schema

Come funziona

  1. 1
    BriefLei incolla o allega endpoint ed esempi
  2. 2
    Struttura e scritturaScriviamo reference e guide
  3. 3
    ConsegnaRiceve Markdown pronto da pubblicare

Cosa ci serve da lei

Descrizioni degli endpoint o un file OpenAPI o Postman incollato come testo, dettagli sull'autenticazione, esempi di richieste e risposte, codici di errore e chi sono gli utenti della sua API.

Le chiederemo:

  • Cosa fa l'API e chi la usa?
  • Come funziona l'autenticazione?
  • Quale linguaggio devono usare gli esempi di codice oltre a cURL?
  • Dove verrà pubblicata la documentazione?

Confronto dei pacchetti

PacchettiBase17 €Standard35 €Premium70 €
Cosa è inclusoGuida rapida e fino a 5 endpointFino a 20 endpoint con guideFino a 50 endpoint, documentazione completa
Tempi di consegna1 giorno3 giorni5 giorni
Revisioni123
Lunghezzafino a 2.000 parolefino a 6.000 parolefino a 14.000 parole
Endpointfino a 5fino a 20fino a 50
Linguaggi degli esempi di codicecURLcURL + 1cURL + 2
Ordina BaseOrdina StandardOrdina Premium

Pagamento protetto

Paga al momento dell'ordine, ma il denaro viene sbloccato solo per un lavoro accettato.

  • Prezzo fissoIl prezzo del pacchetto non cambia dopo il pagamento.
  • Il denaro viene riservatoAl pagamento, l'importo viene solo riservato. Passa a Dleex quando accetta il lavoro.
  • Verificato prima della consegnaOgni risultato passa un controllo di qualità prima di arrivare a lei, e lo vede nella pagina dell'ordine prima di accettarlo.
  • Revisioni gratuiteRichieda revisioni nell'ambito del suo brief tante volte quante ne prevede il pacchetto.
  • Accettazione dopo 3 giorniSe entro 3 giorni dalla consegna non accetta il lavoro né richiede una revisione, il lavoro viene accettato automaticamente. Se scrive nella chat dell'ordine dopo la consegna, l'ordine resta in attesa; dopo la nostra risposta potremmo far ripartire i 3 giorni e glielo indicheremo nella chat.
  • Rifacimento o rimborso totaleSe il risultato non corrisponde al suo brief e le revisioni non hanno risolto il problema, oppure il lavoro richiede più del doppio dei tempi di consegna previsti, scriva nella chat dell'ordine: rifaremo il lavoro o le rimborseremo l'intero pagamento.
Come funziona →

Domande e risposte

Potete lavorare dalla nostra specifica OpenAPI?

Sì, incolli lo YAML o il JSON nel brief. Trasformiamo le sue descrizioni in pagine di reference leggibili e colmiamo le lacune che ci indica.

Testerete gli esempi?

Non chiamiamo la sua API. Gli esempi sono costruiti dai suoi campioni di richiesta e risposta, quindi li esegua una volta prima della pubblicazione.

Scrivete documentazione per SDK?

Sì, se ci invia le firme dei metodi ed esempi d'uso. Ogni SDK conta nel volume del pacchetto.

Non hai trovato la risposta?

Pacchetti