Saltar al contenido principal

SDKs y Postman

Hometown mantiene tres SDKs y una colección de Postman. Los cuatro salen del mismo contrato que muestra la referencia, así que un campo nuevo de la API les llega al mismo tiempo.

LenguajePaqueteRequiere
TypeScript@hometown-workforce/estimator en npmNode.js 20.19 o más reciente
Pythonhometown-estimator en PyPIPython 3.11 o más reciente
PHPhometown/estimator en PackagistPHP 8.2 o más reciente, ext-curl y ext-json

Ninguno instala otro paquete.

Lo que cada SDK hace por ti​

  • Tipos. Cada objeto y cada cuerpo de petición llevan las claves de la API. Tu editor las completa, y un error de dedo falla antes de correr.
  • Idempotencia. Crear una estimación, un seguimiento o un cliente manda su propio Idempotency-Key, o el tuyo. Un reintento lo repite, así que la llamada se cobra una vez.
  • Reintentos. Un 429 o un 503 que trae Retry-After se reintenta hasta dos veces, esperando lo que diga. Una espera de más de 60 segundos no se espera, y nada más se reintenta.
  • Errores. Cada código de error tiene su propia clase de excepción, y cada error que responde la API trae el request_id para dárselo a soporte.
  • Webhooks. Una llamada revisa Hometown-Signature y devuelve el evento, como lo explica la guía de webhooks.
  • Una versión fija. Cada versión manda el Hometown-Version con el que se construyó. Las respuestas conservan la forma que describen sus tipos hasta que actualices.

Versiones​

Las versiones de los SDKs se leen AÑO.MES.PARCHE, como 2026.10.0. Una versión que sigue a un cambio incompatible de la API pasa a un mes nuevo. Un parche nunca cambia lo que devuelve una llamada.

Postman​

Importa postman.json en Postman. Trae una carpeta por cada parte de la API y un cuerpo de ejemplo en cada petición. Pon una llave de prueba en la variable apiKey para probar el sandbox. Cada petición de creación manda un Idempotency-Key nuevo.

Licencia​

Los SDKs tienen código fuente disponible bajo la Functional Source License (FSL-1.1-MIT); cada versión pasa a MIT dos años después de su publicación.