Administración de la API
¿Dónde se administran las API?
Todas las interfaces se administran en el Portal de BulkGate, en Módulos y APIs. La pantalla tiene dos partes:
Mis APIs y módulos: tarjetas de las interfaces que ya ha creado. Haga clic en una tarjeta para abrir su detalle.Descubre nuestras APIs y módulos: el catálogo de todo lo que puede configurar. Al hacer clic en un mosaico se abre una ventana con la descripción, enlaces aSitio webyDocumentacióny el formulario de creación.
¿Cómo se crea una nueva API?
- En el menú, haga clic en
Módulos y APIs - En
Descubre nuestras APIs y módulos, haga clic en el mosaico de la interfaz que quiere configurar - Rellene el formulario de la ventana que se abre
- Haga clic en
Crear API
El formulario varía según el tipo de interfaz:
| Tipo | Campos del formulario |
|---|---|
| API HTTP y módulos basados en token | Nombre y Mensajes API máximos por día |
Email > SMS y Low Level API |
Billetera y Nombre |
| Módulos descargables | sin formulario, solo el botón Obtener módulo |
En las API HTTP, el campo Mensajes API máximos por día es obligatorio: hasta que lo rellene, el botón Crear API permanece desactivado.
Al crear una interfaz, se abre su detalle. En Email > SMS, la parte Ajustes del correo electrónico contiene los datos a los que envía: Recipiente, Asunto SMS corto y Asunto SMS largo.
¿Qué es el Application ID?
El Application ID (APPLICATION_ID) es el número único de su aplicación. Junto con el Application token (APPLICATION_TOKEN) forma las credenciales de acceso a la API.
En el detalle de la aplicación aparece justo debajo del nombre de la aplicación con el formato #39238 y, de nuevo, en la parte Credenciales de acceso.
¿Dónde se encuentran las credenciales de acceso?
- En el menú, haga clic en
Módulos y APIs - En
Mis APIs y módulos, haga clic en la tarjeta de su aplicación - Permanezca en la pestaña
Ajustesy busque la parteCredenciales de acceso
Contiene el Application ID y la lista de tokens. Por seguridad, el token no se muestra directamente: lo solicita con Mostrar ficha y lo confirma con su contraseña. Añadir token y Regenerar token están protegidos del mismo modo. Los detalles se explican en la página Tokens de API.
¿Cómo se activa o desactiva una API?
- Abra el detalle de la aplicación
- Debajo del nombre de la aplicación hay un botón con el estado actual:
ActivooDesactivado - Despliéguelo y elija
HabilitaroInhabilitar - Confirme en la ventana
Cambiar Estado
Una API desactivada rechaza todas las solicitudes. Una API activada acepta todas las solicitudes.
¿Cómo se cambia el nombre de una API o se elimina?
En la esquina superior derecha del detalle está el botón Rebautizar. Abre una ventana con el campo Nombre; el cambio se confirma de nuevo con Rebautizar.
La flecha que hay junto a él despliega un menú con la opción Borrar.
La eliminación de una aplicación no se puede deshacer y elimina también todos los tokens que le pertenecen.
¿Cómo se configuran los informes de entrega?
El detalle de la aplicación contiene, en la pestaña Ajustes, la parte Web hooks con
la tarjeta Informes de entrega. En ella se indica la dirección a la que BulkGate
informará del estado de los mensajes enviados y entregará las respuestas entrantes.
Todo el procedimiento y todas las opciones se describen en la página Webhooks.
Gracias por su opinión.