Saltar al contenido principal

Búsqueda

Bienvenido al Centro de Ayuda de Tecnosinergia

Guía de API de GDMS

Irving Gonzalez
  • Actualización

Descripción general

La API de GDMS permite a los usuarios realizar una serie de acciones mediante solicitudes HTTPS, lo que facilita al usuario automatizar el proceso y emitir una gran cantidad de comandos.

En esta guía, presentaremos los tipos de acciones y el método para ejecutar comandos, así como la sintaxis necesaria para ejecutarlos correctamente. Encontrará funciones Curl y la colección de comandos Postman que permiten consultar el GDMS para recuperar información o agregar o eliminar un dispositivo o una tarea.

Rizo

Generar el token

  1. Para obtener la contraseña de inicio de sesión en hash como MD5, puede usar https://emn178.github.io/online-tools/md5.html

  2. El resultado del hash MD5 como SHA256 lo puedes usar https://emn178.github.io/online-tools/sha256.html

  3. En la interfaz web de GDMS → Otros → Desarrollador de API → Activar: Obtener la información del desarrollador de API

 

curl -sik -d 'nombre de usuario= [Nombre de usuario de GDMS ]&contraseña=[ ( Contraseña ) ]&tipo de concesión=contraseña&id de cliente=[ ID de API ]&secreto de cliente=[ Clave secreta ]' –header 'Aceptar: aplicación/json' –header 'Tipo de contenido: aplicación/x-www-form-urlencoded' -X POST https://www.gdms.cloud/oapi/oauth/token

“””

Respuesta: (Sus respuestas serán diferentes a las siguientes)

FICHA ( ficha ):

  13dac871-38c2-4261-a698-6481840617cc

ACTUALIZAR TOKEN ( rtoken ):

  15fac8ef-d15f-4cec-9128-e6f55005cba4

Utilice el token de actualización cada hora
 

curl -sik -d 'tipo_concesión=token_de_actualización&token_de_actualización= rtoken &id_de_cliente= ID_de_API &secreto_de_cliente= Clave_secreta ' –header 'Aceptar: aplicación/json' –header 'Tipo_de_contenido: aplicación/x-www-form-urlencoded' -X POST https://www.gdms.cloud/oapi/oauth/token

Marca de tiempo

Necesitará crear una marca de tiempo en milisegundos como tiempo de época, puede usar https://www.epochconverter.com/

Podría verse así: (tstamp): 1622241631000

Firma de la organización:

  1. Crea tu oración de esta manera: &access_token= token &client_id= API_ID &client_secret= Secret_Key ×tamp= tstamp & Nota: El & debe estar incluido.

  2. El resultado debe ser un hash como SHA256, herramienta: https://emn178.github.io/online-tools/sha256.html

  3. El resultado obtenido es la (firma)

Obtenga una lista de sus organizaciones desde la API

  1. En su navegador web ingrese la siguiente URL ajustando sus credenciales:

  2. https://www.gdms.cloud/oapi/v1.0.0/org/list?access_token= token &signature= firma ×tamp= tstamp

  3. La respuesta recibida se verá así: (orgid){“data”:{“result”:[{ “id”:1136 ,”organization”:”Default”,”description”:””,”isDefault”:1,”createTime”:1567221861000}],”total”:1,”pages”:1,”pageSize”:20,”pageNum”:1},”msg”:””,”retCode”:0}

Obtenga una lista de sus sitios desde la API

  1. En su navegador web ingrese la siguiente URL ajustando sus credenciales:

  2. https://www.gdms.cloud/oapi/v1.0.0/site/list?access_token= token &signature= firma ×tamp= tstamp

  3. La respuesta recibida se verá así: (siteid){“data”:{“result”:[{“id”:3345,”isDefault”:1,”description”:”Default Site”,”siteName”:”Default”,”children”:[]}]},”msg”:””,”retCode”:0}

Agregar un dispositivo

  1. Complete esta oración con sus datos: [{“deviceName”:”device_name”,”mac”:”XY:XY:XY:XY:XY:XY”,”sn”:”YOURSN”,”siteId”:3345,”orgId”:1136}]
    Nota : se deben incluir [], {}, “”, y la dirección MAC debe tener el formato XY:XY:XY:XY:XY:XY

  2. El resultado debe ser un hash como SHA256, puedes usar
    https://emn178.github.io/online-tools/sha256.html ( device_hash )

  3. Construya la siguiente oración: &access_token= token &client_id= API_ID &client_secret= Secret_Key ×tamp= tstamp & device_hash &
    Nota : El & debe incluirse.

  4. El resultado debe ser un hash como SHA256, herramienta: https://emn178.github.io/online-tools/sha256.html

  5. La estructura a construir es:curl -sik -d '[{“deviceName”:”nombre_del_dispositivo”,”mac”:”XY:XY:XY:XY:XY:XY”,”sn”:”YOURSN”,”siteId”:3345,”orgId”:1136}]' –header 'Aceptar: aplicación/json' –header 'Tipo-de-contenido: aplicación/json' -X POST 'https://www.gdms.cloud/oapi/v1.0.0/device/add?access_token= token &signature= signature ×tamp= tstamp '

  6. El comando curl se vería así:'https://www.gdms.cloud/oapi/v1.0.0/device/add?access_token=6f1cf2db-3f96-4a20-ad76-fc49cf003149&signature=b6908e2cd6565112554fbd1587402496857c7b56818647b273623915bf248c35×tamp=1621958396000'

Agregar una tarea

  1. Complete esta oración con sus datos:'{“taskName”:”REBOOT”,”taskType”:1,”macList”:[“ XY:XY:XY:XY:XY:XY “],”execType”:1}'
    Nota: [], {}, “”, deben incluirse y la dirección MAC debe tener el formato XY:XY:XY:XY:XY:XY

  2. El resultado debe ser un hash como SHA256, puedes usar
    https://emn178.github.io/online-tools/sha256.html ( task_hash )

  3. Construya la siguiente oración: &access_token= token &client_id= API_ID &client_secret= Secret_Key ×tamp= tstamp & task_hash &
    Nota : El & debe incluirse.

  4. El resultado debe ser un hash como SHA256, puedes usar
    https://emn178.github.io/online-tools/sha256.html

  5. El comando curl sería similar:curl -sik -d ”{“taskName”:”REBOOT”,”taskType”:1,”macList”:[“XY:XY:XY:XY:XY:XY”],”execType”:1}' –header 'Accept: application/json' –header 'Content-type: application/json' -X POST 'https://www.gdms.cloud/oapi/v1.0.0/task/add?access_token= token &signature= signature ×tamp= tstamp 'Se vería algo así:'https://www.gdms.cloud/oapi/v1.0.0/device/add?access_token=6f1cf2db-3f96-4a20-ad76-fc49cf003149&signature=b6908e2cd6565112554fbd1587402496857c7b56818647b273623915bf248c35×tamp=1621958396000'

Cartero

Uso de la colección de API de GDMS (Descargar desde aquí ), En la interfaz web de GDMS → Otros → Desarrollador de API → Activar: Obtener la información del desarrollador de API

Descarga Postman en → https://www.postman.com/

Abra la aplicación Postman

  1. Importar colección como archivo

  2. Verifique las Variables Ambientales e ingrese sus credenciales en VALOR ACTUAL.

  3. Debe completarse como:

    • Nombre de usuario: nombre de usuario de GDMS

    • Contraseña: Contraseña de inicio de sesión de GDMS

    • Client_secret: Secreto del cliente de la API de GDMS

    • ID de cliente: ID de cliente de GDMS

Solicitud de token de acceso

Tras ingresar las credenciales, puede enviar la solicitud de token de acceso POST .
Si las credenciales son correctas, recibirá la respuesta en formato JSON, como se muestra en la imagen a continuación.

Obtener ID de organizaciones

Después de ejecutar la solicitud de token de acceso, se puede enviar la solicitud Obtener ID de organizaciones, el cartero continuará con las variables necesarias.

La respuesta sería similar a esta:

Tome nota del ID de la organización, en este caso es 13916 pero según las nuevas credenciales variará.

Obtener el ID del sitio

Luego se puede ejecutar la solicitud “Obtener ID de organizaciones” y el cartero continuará con las variables necesarias.

La respuesta recibida será similar a esta, dependiendo del sitio.

Tome nota del ID del sitio, en este caso es 54010, pero según las nuevas credenciales variará.

Agregar dispositivo

En la interfaz de usuario de Postman → Agregar una solicitud de dispositivo → Script de solicitud previa

Los valores resaltados deben reemplazarse con los datos reales.

Una respuesta exitosa se verá así:

Agregar tarea

A modo de ejemplo, la tarea de reinicio se podría crear en Agregar una solicitud de tarea → Script de solicitud previa

El campo resaltado debe reemplazarse con los datos reales.

Una respuesta exitosa se verá así:

Solicitar puesto de desarrollador de API

La plataforma GDMS ofrece interfaces API a usuarios públicos. Los usuarios pueden solicitar el uso de los servicios como Desarrollador API. Pueden hacer clic para ver los detalles de las interfaces API.

Dirección de acceso al documento API: https://doc.grandstream.dev/GDMS-API/

  1. Haga clic en “ Desarrollador de API ” en el menú del lado izquierdo y haga clic para solicitar Desarrollador de API.

  1. Haga clic en “Solicitar desarrollador de API”, la plataforma GDMS asignará el ID de cliente de API y la clave secreta a la cuenta GDMS, y la cuenta GDMS puede usar el ID de cliente de API y la clave secreta para invocar las interfaces API.

  1. Si el usuario desea deshabilitar la función API Developer, puede hacer clic en “Deshabilitar API Developer” para dejar de invocar las interfaces API.

 

1. Dirección de la API de llamada:

La dirección de la API es: https://{gdms_domain}/oapi/xxx.

  • Si su cuenta GDMS está en la región de EE. UU., el {gdms_domain} se puede completar con www.gdms.cloud.

  • Si su cuenta GDMS está en la región de la UE, el {gdms_domain} se puede completar con eu.gdms.cloud.

2. Cuando la función de Desarrollador de API está deshabilitada, la clave secreta de API anterior deja de ser válida y el usuario no puede acceder a las interfaces de GDMS. Si el usuario intenta volver a solicitar la función de Desarrollador de API, el sistema asignará otra clave secreta a la cuenta de GDMS.

Comentarios

0 comentarios

Inicie sesión para dejar un comentario.