Conector de Redes
OpenAPIAPI v0.1.0
Explorar documentación

Empezar · 5 minutos

Crea tu primera operación de forma segura.

El recorrido siempre comienza consultando la configuración asignada a tu cliente. No copies códigos de conexiones, artículos u orígenes de otro ambiente.

Antes de empezar

  • Una credencial del Conector para tu cliente y ambiente.
  • Los scopes connections:read, articles:read y shipments:write.
  • Una conexión activa con el transportista que vas a utilizar.
  • Un código de artículo o servicio habilitado para esa conexión.

Las credenciales del Conector son distintas de las credenciales del transportista. Para MensaGlobal, tu empresa registrará su propia API key por conexión cuando se habilite el flujo autenticado. En ningún caso se envía la clave del transportista en cada alta de envío.

1

Configura el ambiente

Guarda la credencial en un gestor de secretos y exponla sólo al proceso servidor que realiza la integración.

Terminal
export API_BASE_URL="https://api.sandbox.conector.sendingbay.net"
export SENDINGBAY_API_TOKEN="<credencial-del-ambiente>"
2

Consulta tus conexiones

El identificador representa el contrato de tu cliente con un transportista. Utiliza únicamente conexiones activas devueltas por el API. article_resolution_mode indica qué sistema de códigos utiliza cada conexión, incluso si no hay servicios publicados.

GET /v1/carrier-connections
curl --request GET \
  --url "$API_BASE_URL/v1/carrier-connections" \
  --header "Authorization: Bearer $SENDINGBAY_API_TOKEN"
3

Consulta artículos y restricciones

Esta vista informa los códigos utilizables, opciones y condiciones exactas para la conexión elegida: cobertura, bultos, pesos, dimensiones y datos obligatorios. El campo code_systemdistingue artículos canónicos de servicios propios de la conexión.

GET /v1/carrier-connections/{id}/articles
curl --request GET \
  --url "$API_BASE_URL/v1/carrier-connections/<connection-id>/articles" \
  --header "Authorization: Bearer $SENDINGBAY_API_TOKEN"
4

Crea el envío

Reemplaza la conexión y los datos de ejemplo. La clave de idempotencia debe identificar esta intención de envío y conservarse durante los reintentos.

POST /v1/shipments
curl --request POST \
  --url "$API_BASE_URL/v1/shipments" \
  --header "Authorization: Bearer $SENDINGBAY_API_TOKEN" \
  --header "Idempotency-Key: pedido-9842-envio-1" \
  --header "Content-Type: application/json" \
  --data '{
    "carrier_connection_id": "11111111-1111-4111-8111-111111111111",
    "article_code": "24",
    "origin_code": "WAREHOUSE_MADRID",
    "sender": {
      "name": "Tienda de prueba",
      "address_line1": "Calle Origen 1",
      "city": "Madrid",
      "postal_code": "28001",
      "country_code": "ES"
    },
    "recipient": {
      "name": "Cliente de prueba",
      "address_line1": "Calle Destino 1",
      "city": "Madrid",
      "postal_code": "28002",
      "country_code": "ES",
      "phone": "600000002"
    },
    "packages": [{ "weight_kg": 1.25 }],
    "shipping_date": "2026-09-10",
    "external_reference": "PED-9842"
  }'
Siguiente lectura

Cómo proteger y rotar las credenciales.

Ir a autenticación →