Atoship
Docs
Centro de ayudaGitHub

Colecciones de Postman

Descarga y usa nuestras colecciones oficiales de Postman para probar e integrar la API de atoship en minutos.

Colección de la API de atoship
v2.1
Lista
Colección completa con 15 endpoints de la API, que incluye las APIs V1 más recientes, autenticación, direcciones, tarifas, etiquetas, seguimiento y gestión de transportistas.
Descargar colección
Endpoints
15 endpoints de la API
Última actualización
2026-02-18
Tamaño
9.4 KB
Formato
Postman v2.1
Variables de entorno
Obligatorio
Variables de entorno preconfiguradas para los entornos de desarrollo, staging y producción.
DesarrolloProducción
Entorno de desarrollo
http://localhost:3001
Local
Entorno de producción
https://atoship.com/api
En vivo

Primeros pasos

1. Importar la colección

Descarga la colección de la API de atoship e impórtala en tu espacio de trabajo de Postman.

2. Configurar el entorno

Configura tus claves de API y las URL base con nuestras plantillas de entorno.

3. Probar los endpoints

Empieza a probar los endpoints de la API con solicitudes y ejemplos preconfigurados.

4. Automatización

Usa Newman o el CLI de Postman para ejecutar colecciones en tu pipeline de CI/CD.

Configuración del entorno

Variables obligatorias
Define estas variables de entorno en tu entorno de Postman para autenticar y configurar las solicitudes a la API.
api_key

Tu clave de API de atoship

ak_test_1234567890abcdef
base_url

URL base de la API

https://atoship.com/api/v1
environment

Tipo de entorno

development | production
timeout

Tiempo de espera de la solicitud (ms)

30000
Plantillas de entorno
Entornos preconfigurados para las distintas etapas del desarrollo.

Entorno de desarrollo
Local

{
  "name": "atoship Development",
  "values": [
    {
      "key": "base_url",
      "value": "http://localhost:3001/api",
      "enabled": true
    },
    {
      "key": "api_key",
      "value": "ak_test_1234567890abcdef",
      "enabled": true
    },
    {
      "key": "environment",
      "value": "development",
      "enabled": true
    }
  ]
}

Entorno de producción
En vivo

{
  "name": "atoship Production",
  "values": [
    {
      "key": "base_url",
      "value": "https://atoship.com/api/v1",
      "enabled": true
    },
    {
      "key": "api_key",
      "value": "ak_live_your_production_key",
      "enabled": true
    },
    {
      "key": "environment",
      "value": "production",
      "enabled": true
    }
  ]
}
Instrucciones de configuración
Guía paso a paso para configurar tu entorno de Postman.
1

Importar el archivo de entorno

Descarga el archivo JSON de entorno e impórtalo en Postman con el botón "Import".

2

Actualizar la clave de API

Reemplaza la clave de API de ejemplo por tu clave de API real de atoship, disponible en el panel de control.

3

Seleccionar el entorno

Elige el entorno importado en el menú desplegable de entornos, en la esquina superior derecha.

4

Probar la conexión

Ejecuta una solicitud GET sencilla para verificar que la configuración de tu entorno funciona correctamente.

Cobertura de la API

Cobertura completa de los endpoints de la API
Nuestra colección de Postman cubre todos los endpoints disponibles de la API, organizados por funcionalidad.

Autenticación

V1

Gestión de claves de API para sandbox y producción.

  • • Crear clave de API
  • • Listar claves de API
  • • Eliminar clave de API

Cuenta

Básico

Configuración de la cuenta, saldo, usuarios y transportistas.

  • • Obtener/actualizar la cuenta
  • • Saldo y transacciones
  • • Usuarios y equipos
  • • Cuentas de transportista (BYOCA)

Direcciones

Básico

Crea, valida y gestiona direcciones de envío.

  • • Crear dirección
  • • Verificar dirección
  • • Obtener/listar direcciones

Tarifas

Básico

Obtén tarifas de envío de varios transportistas.

  • • Obtener tarifas de envío
  • • Soporte de tarifas BYOCA
  • • Comparación entre transportistas

Etiquetas

Popular

Crea, gestiona y descarga etiquetas de envío.

  • • Crear/obtener/listar etiquetas
  • • Integración de seguimiento
  • • Anular/reembolsar etiquetas
  • • Cobertura de seguro
  • • Desglose de tarifas

Devoluciones y webhooks

Avanzado

Etiquetas de devolución, códigos QR y notificaciones de eventos.

  • • Crear etiquetas/QR de devolución
  • • Endpoints de webhook
  • • Eventos en tiempo real
  • • Gestión de reclamaciones

Características de la colección

Scripts previos a la solicitud

Gestión automática del token de autenticación y firma de solicitudes.

Scripts de prueba

Pruebas integradas de validación de respuestas y manejo de errores.

Respuestas de ejemplo

Respuestas reales de la API para cada endpoint, con datos de muestra.

Escenarios de error

Casos de prueba para diversas condiciones de error y casos límite.

Flujos de trabajo

Flujos de trabajo de extremo a extremo para patrones de integración comunes.

Documentación

Documentación integrada y ejemplos de uso para cada endpoint.

Flujo de inicio rápido

Ejemplo de flujo de envío completo
Prueba un proceso de envío completo de extremo a extremo con nuestras solicitudes preconfiguradas.

Flujo básico (5 pasos)

1
Crear/verificar dirección
POST /v1/addresses
2
Obtener tarifas de envío
POST /v1/rates
3
Crear etiqueta
POST /v1/labels
4
Rastrear paquete
GET /v1/tracking/:tracking_number
5
Configurar webhooks
POST /v1/webhooks

Funciones avanzadas

Lote
Operaciones masivas

Procesa varios envíos a la vez con las APIs por lotes

IA
Enrutamiento inteligente

Selección de transportista y optimización de rutas con IA

Webhook
Actualizaciones en tiempo real

Notificaciones automáticas de seguimiento y cambios de estado

Devoluciones
Etiquetas de devolución

Genera etiquetas de devolución y gestiona los flujos de devolución

¿Listo para empezar a probar?

Importa nuestra colección y sigue el flujo de trabajo anterior

Descargar colecciónProbar el API Playground
atoship © 2026