Step By Step Crochet per sviluppatori

API pubblica e interfacce per agenti

Cerca e leggi le guide all’uncinetto pubblicate sul sito tramite un’API REST con versionamento, MCP Streamable HTTP, A2A, rappresentazioni Markdown o WebMCP. Tutte le interfacce di questa pagina sono anonime, di sola lettura e gratuite: non servono un account, una chiave API, un flusso OAuth o un token di accesso.

REST API

L’URL di base in produzione è https://stepbystepcrochet.com. Le risposte utilizzano JSON e includono gli URL canonici HTML e Markdown. I valori supportati per la lingua sono en, es, de, fr, pt e it.

GET/api/v1/guides

Cerca nei titoli e negli estratti. Parametri di query: locale, q facoltativo fino a 200 caratteri e limit facoltativo da 1 a 20.

curl "https://stepbystepcrochet.com/api/v1/guides?locale=es&q=granny&limit=5"
GET/api/v1/guides/{slug}

Recupera una guida completa in Markdown. Riutilizza i valori slug e locale restituiti dall’endpoint della raccolta.

curl "https://stepbystepcrochet.com/api/v1/guides/how-to-make-a-granny-square?locale=en"
POST/api/v1/guides/search

Esegui la stessa ricerca di sola lettura con un corpo JSON. Gli agenti possono includere un’intestazione Idempotency-Key per riprovare in sicurezza; una chiave valida viene riportata nella risposta e l’operazione non crea né modifica mai contenuti.

curl -X POST "https://stepbystepcrochet.com/api/v1/guides/search" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 8b7668ca-55b1-4872-912e-7c9d0474545d" \
  -d '{"locale":"es","query":"granny square","limit":5}'

Errori e uso responsabile

Gli errori utilizzano un oggetto error con un code stabile, un message leggibile, un hint per correggere il problema e dettagli facoltativi. I parametri non validi restituiscono HTTP 400, le guide mancanti e i percorsi API sconosciuti HTTP 404, e i metodi non supportati HTTP 405 con un’intestazione Allow. Queste risposte restano in JSON anziché mostrare una pagina di errore HTML. Le risposte GET riuscite possono essere memorizzate nella cache. Non è pubblicata una quota di richieste; chi usa il servizio dovrebbe memorizzare i risultati nella cache, evitare interrogazioni periodiche non necessarie e rallentare le richieste se il servizio restituisce HTTP 429 o 5xx.

{
  "error": {
    "code": "INVALID_LOCALE",
    "message": "Unsupported locale: nl",
    "hint": "Use one of: en, es, de, fr, pt, it.",
    "details": { "parameter": "locale" }
  }
}

MCP e MCP Apps

Collega un client MCP a https://stepbystepcrochet.com/api/mcp tramite Streamable HTTP. Il server espone find_crochet_guides e read_crochet_guide. I risultati di ricerca includono una risorsa MCP App ui:// per schede interattive delle guide, insieme a un’alternativa testuale.

Altre risorse leggibili dalle macchine