create
Para agregar una aplicación al servicio, utilice el método apps/create. La aplicación agregada aparece en la lista de la ventana Administrar Apps de CMS Manager.
En Wialon Hosting, solo el usuario de nivel superior del servicio puede utilizar este método.
Endpoint
svc=apps/create¶ms={
"name": <text>,
"description": <text>,
"url": <text>,
"flags": <uint>,
"langs": <text>,
"sortOrder": <int>,
"requiredServicesList": <text>,
"billingPlans": <text>
}
Parámetros
La solicitud debe contener todos los siguientes parámetros. Si un parámetro no es necesario para su aplicación, indique un valor vacío ("" para los parámetros de texto y 0 para los numéricos).
| Parámetro | Descripción |
|---|---|
| name | Nombre de la aplicación. No puede estar vacío. |
| description | Descripción de la aplicación. También se utiliza como descripción del servicio de la aplicación. Puede dejarla vacía. |
| url | URL donde se aloja la aplicación. Debe empezar por http://, https:// o //. |
| flags | Flags de la aplicación (parámetros avanzados de URL). Para ver los valores posibles, consulte Flags. Utilice 0 si no necesita ninguno. |
| langs | Idiomas de la interfaz para los que está disponible la aplicación, separados por comas, por ejemplo, "en,ru". Si el valor está vacío, la aplicación está disponible para todos los idiomas. |
| sortOrder | Orden de clasificación de la aplicación en la lista. |
| requiredServicesList | Nombres de los servicios requeridos para la aplicación, separados por comas. Cada servicio debe estar disponible en su cuenta. No agregue una coma al final de la lista. Puede dejarlo vacío. |
| billingPlans | Nombres de los planes de facturación para los que está disponible la aplicación, separados por comas. Cada plan de facturación debe existir en su servicio. Puede dejarlo vacío. |
Para obtener más información sobre los parámetros de la aplicación, consulte Apps.
Flags
El parámetro flags define qué parámetros se agregan a la URL de la aplicación cuando el usuario la abre. Cada flag corresponde a una opción de los parámetros avanzados de URL en CMS Manager. Para combinar varios flags, sume sus valores. Por ejemplo, las aplicaciones de la biblioteca utilizan el valor 31 (0x1F): 0x1 + 0x2 + 0x4 + 0x8 + 0x10.
| Valor | Opción en CMS Manager | Parámetro que se agrega a la URL de la aplicación |
|---|---|---|
0x1 (1) |
Active SID | sid=<ID de la sesión>. Autenticación por ID de sesión: el usuario permanece en la aplicación después de actualizar la página. |
0x2 (2) |
Current user | user=<nombre del usuario actual>. |
0x4 (4) |
Base URL | baseUrl=<dirección de la API>, por ejemplo, https://hst-api.wialon.com. |
0x8 (8) |
Host URL | hostUrl=<dirección desde la que el usuario abrió la aplicación>, por ejemplo, https://hosting.wialon.com. |
0x10 (16) |
Language | lang=<idioma de la interfaz del usuario actual>. |
0x20 (32) |
Authorise hash | authHash=<hash>. Autenticación por hash creado con el método core/create_auth_hash: la sesión de la aplicación se cierra después de actualizar la página. |
Para que los usuarios puedan iniciar sesión en la aplicación, especifique el flag
0x1(Active SID) o0x20(Authorise hash).
Al crear una aplicación, el sistema también hace lo siguiente:
- crea el servicio
app.<serviceName>en su cuenta (el servicio Visualización en el menú: <nombre de la aplicación> en CMS Manager); - agrega este servicio a los planes de facturación indicados en el parámetro
billingPlans.
Ejemplo
svc=apps/create¶ms={
"name": "My app",
"description": "",
"url": "https://example.com/app",
"flags": 31,
"langs": "",
"sortOrder": 0,
"requiredServicesList": "",
"billingPlans": ""
}
En este ejemplo, el valor de flags 31 agrega los parámetros sid, user, baseUrl, hostUrl y lang a la URL de la aplicación. Para obtener más información, consulte Flags.
Respuesta
Si la solicitud se completa con éxito, la respuesta se devuelve en el siguiente formato:
[
<long>, /* ID de la aplicación */
{
"name": <text>, /* Nombre de la aplicación */
"description": <text>, /* Descripción de la aplicación */
"url": <text>, /* URL de la aplicación */
"flags": <uint>, /* Flags de la aplicación */
"sortOrder": <int>, /* Orden de clasificación */
"serviceName": <text>, /* Nombre del servicio de la aplicación sin el prefijo "app." */
"id": <long>, /* ID de la aplicación */
"langs": <text>, /* Idiomas de la interfaz */
"requiredServicesList": <text>, /* Servicios requeridos */
"billingPlans": <text> /* Planes de facturación */
}
]
Si la solicitud falla, se devuelve un código de error.
Códigos de error
| Código de error | Descripción |
|---|---|
| 4 | Parámetros de entrada incorrectos o falta uno de los parámetros. |
| 7 | Acceso denegado: el usuario no es el usuario de nivel superior del servicio o el servicio no es Wialon Hosting. Este código también se devuelve si el nombre o la URL son incorrectos, un servicio requerido o un plan de facturación no está disponible o no se puede crear la aplicación. |