Skip to main content
La clave API identifica a tu organización ante la API pública de ContactShip. La app admite una clave por organización. El plan debe incluir acceso a la API; un permiso administrativo no reemplaza ese requisito.

​
Generar y usar

  1. Elegí la organización con la que va a trabajar tu integración.
  2. Abrí Claves API y usá el botón para generar la clave.
  3. Copiala y guardala en la configuración privada de tu servidor o herramienta de automatización.
  4. Enviá el valor en el encabezado x-api-key de las solicitudes a la API.
Reemplazá YOUR_API_KEY en tu entorno privado. No incluyas la clave en páginas web públicas, URLs, capturas ni tickets de soporte.

​
Permisos y disponibilidad

La pantalla no ofrece claves individuales con permisos o alcances personalizados. No asumas que una clave tiene el mismo alcance restringido que un miembro humano.

​
Eliminar o reemplazar

Eliminar la clave interrumpe las integraciones que la usan. Identificá los sistemas dependientes antes de reemplazarla y actualizá sus credenciales.
Si necesitás reemplazarla, coordiná la eliminación, generación y actualización de los sistemas que la consumen. No se documenta un período de coexistencia entre claves.

​
Problemas frecuentes

​
Preguntas frecuentes

Cada clave pertenece a una organización. Configurá credenciales separadas para trabajar con organizaciones diferentes.
El configurador actual no ofrece alcances por clave. No la uses como si fuera una credencial de solo lectura.
Enviá método, ruta, hora y código de respuesta. Reemplazá la clave y otros secretos por valores ocultos.

​
Ver también