Información
Contenido

Crear cliente, usuarios, activos, equipos y tarjetas sim - createClientAndElements

POST https://api.service24gps.com/api/v1/createclientandelements

Este método permite crear cliente, usuarios, activos, equipos y tarjetas sim.

Ver parámetros de solicitud:
Parámetros Descripción Ejemplo
apikey (Requerido) Llave de autorización para uso de los Servicios Web. 25sdsd234234aa93sdsdsd37c70118e72
token (Requerido) Token devuelto por el método getToken.
SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw==
client

(Requerido) String en formato json de datos del cliente a crear  

{
    "city":"ciudad",
    "country_id":"2",
    "time_zone_id":"16",
    "state_id":"21",
    "postal_code":"72000",
    "phone":"1234567890",
    "email":"correo@host.com",
    "name":"nombre",
    "register_number":"numero registro",
    "business_name":"nombre",
    "full_address":"direccion",
    "custom_field":[
        {
            "name":"nombre campo uno",
            "value":"valor uno"
        },
        {
            "name":"nombre campo dos",
            "value":"valor dos"
        }
    ]
}

users

(Requerido) String en formato json de datos para crear usuarios..

[
    {
        "name": "nombre usuario",
        "username": "usuario",
        "password": "contraseña",
        "email": "correo@host.com",
        "assets": [
            "placa"
        ],
        "profile_id": 1,
        "send_email_welcome": 1
    },
    {
        "name": "nombre usuario",
        "username": "usuario",
        "password": "contraseña",
        "email": "correo@host.com",
        "assets": [
            "placa"
        ],
        "profile_id": 1,
        "send_email_welcome": 0
    }
]

assets

(Requerido) String en formato json de datos para crear equipos, activos y sims

 

[

    {
        "asset": {
            "name": "activo",
            "plate": "placa",
            "asset_type_id": "1",
            "asset_brand_id": "5",
            "model": "2022",
            "year": "2022",
            "custom_field": [
                {
                    "name": "nombre campo uno",
                    "value": "valor uno asset"
                },
                {
                    "name": "nombre campo dos",
                    "value": "valor uno asset"
                }
            ]
        },
        "device": {
            "device_type_id": "1",
            "name": "equipo",
            "imei_uid": "2022202220222022",
            "brand_id": "1",
            "model_id": "1",
            "time_zone_id": "16",
            "unlink_vehicle": "2023-01-01"
        },
        "sim": {
            "name": "nombre",
            "company_id": "1",
            "phone_number": "12345678900",
            "nip_number": "123456"
        },
        "IdSensors_template": 1415
    }
]

Nota: users y assets son un array de objetos, así sea un solo elemento debe estar dentro de un array.

Ver  tabla de parámetros client:
Parámetros Descripción Ejemplo
city (Requerido) Ciudad.

"city": "ciudad"
country_id (Requerido) Id pais. "country_id": "2"
time_zone_id (Requerido) Id zona horaria. "time_zone_id":"16"
state_id (Opcional) Estado. "state_id":"21",
postal_code (Opcional) Código postal. "postal_code": 72000
phone (Opcional) Teléfono.

"phone":"1234567890"
email (Opcional) Correo electrónico.

"email":"correo@host.com"
name (Requerido) Nombre.

"name":"nombre"
register_number (Opcional) RFC.

"register_number":"numero registro"
business_name (Opcional) Razón social.

"business_name":"nombre"
full_addres (Opcional) Domicilio.

"full_address":"direccion"
custom_fields (Opcional) Campos personalizados.
"custom_field":[
    {
        "name":"nombre campo uno",
        "value":"valor uno"
    },
    {
        "name":"nombre campo dos",
            "value":"valor dos"
        }
]
Ver  tabla de parámetros users:
Parámetros Descripción Ejemplo
name (Opcional) Nombre del usuario. "name": "nombre usuario"
username (Requerido) Usuario. "username": "usuario"
password (Opcional) Contraseña. "password": "contraseña"
email (Requerido) Correo. "email": "correo@host.com"
assets (Opcional) activos. "assets": [
    "placa"
]
profile_id (Opcional) Grupo sistema.

"profile_id": 1
send_email_welcome (Opcional) Enviar correo de bienvenida.

"send_email_welcome": 0
Ver  tabla de parámetros assets:
Parámetros Descripción Ejemplo
asset (Requerido) String en formato json de vehículo

"name": "nombre usuario"

{
    "name": "activo",
    "plate": "placa",
    "asset_type_id": "1",
    "asset_brand_id": "5",
    "model": "2022",
    "year": "2022",
    "custom_field": [
        {
            "name": "nombre campo uno",
            "value": "valor uno asset"
        },
        {
            "name": "nombre campo dos",
             "value": "valor uno asset"
        }
    ]
}

device (Requerido) String en formato json de Equipo.

{
    "device_type_id": "1",
    "name": "equipo",
    "imei_uid": "202220222022202212055",
    "brand_id": "1",
    "model_id": "1",
    "time_zone_id": "16",
    "unlink_vehicle": "2023-01-01"
}

sim (Requerido) String en formato json de chip.

{
    "name": "sim12055",
    "company_id": "1",
    "phone_number": "1234567890012055",
    "nip_number": "123456"
}

IdSensors_template (Opcional) Plantilla. "IdSensors_template": 1415
Ver  tabla de parámetros asset:
Parámetros Descripción Ejemplo
name (Requerido) Nombre.

"name": "activo12055",
plate (Requerido) Placa. "plate": "placa"
asset_type_id (Requerido) Id tipo. "asset_type_id": "1"
marca (Opcional) Id Marca. "asset_brand_id": "5"
model (Opcional) Modelo. "model": "2022"
year (Opcional) Año. "year": "2022",
assets (Opcional) Campos personalizados. "custom_field": [ {
    "name":"nombre campo uno",
    "value":"valor uno asset"
}, {
    "name":"nombre campo dos",
    "value":"valor uno asset"
}]
Ver  tabla de parámetros device:
Parámetros Descripción Ejemplo
device_type_id (Requerido) Id tipo dispositivo. "device_type_id": "1"
name (Requerido) Nombre. "name": "equipo"
imei_uid (Opcional) Imei. "imei_uid": "202220222022202212055"
brand_id (Requerido) Id marca. "brand_id": "1"
model_id (Requerido) Id modelo. "model_id": "1"
time_zone_id (Opcional) Id zona horaria.

"time_zone_id": "16"
unlink_vehicle (Opcional) Fecha.

"unlink_vehicle": "2023-01-01"
Ver  tabla de parámetros sim:
Parámetros Descripción Ejemplo
name (Requerido) Nombre. "name": "sim12055"
company (Opcional) Id compania. "company_id": "1"
phone_number (Requerido) Númeor de telefono. "phone_number": "1234567890012055"
nip_number (Opcional) nip. "nip_number": "123456"
 
Solicitud de ejemplo:
curl --location --request POST 'http://api.service24gps.com/api/v1/createclientandelements' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: PHPSESSID=bduahaoj4mpc5h67p39fn0ahh6' \
--data-urlencode 'token=SJx5eXC7PtSP98YutHgP/wc990+6mK+PFfw2RVblNgQx0PyoR1v/sg==' \
--data-urlencode 'client={
  "city": "puebla",
  "country_id": "2",
  "time_zone_id": "16",
  "state_id": "21",
  "postal_code": "72810",
  "phone": "12345678",
  "email": "caguilar@redgps.com",
  "name": "apiprod1201",
  "register_number": "clienteapi29c29",
  "business_name": "cliente api",
  "full_address": "Primer retorno de Osa Menor número 2, oficina 301, San Andrés Cholula, Puebla, México.",
  "custom_field": [{"name":"Campo Personalizado 1","value":"Testing 1"},{"name":"Campo Personalizado 2","value":"Testing 2"}]
}' \
--data-urlencode 'users=[
  {
    "name": "nombre usuario",
    "username": "usuario",
    "password": "contraseña",
    "email": "correo@host.com",
    "assets": [
      "placa"
     ],
    "profile_id": 1,
    "send_email_welcome": 1
  },
  {
    "name": "nombre usuario",
    "username": "usuario",
    "password": "contraseña",
    "email": "correo@host.com",
    "assets": [
      "placa"
     ],
    "profile_id": 1,
    "send_email_welcome": 0
  }
]' \
--data-urlencode 'assets=[
  {
    "asset": {
      "name": "activo",
      "plate": "placa",
      "asset_type_id": "1",
      "asset_brand_id": "5",
      "model": "2022",
      "year": "2022",
      "custom_field": [ {
        "name":"nombre campo uno",
        "value":"valor uno asset"
      }, {
        "name":"nombre campo dos",
        "value":"valor uno asset"
      }]
    },
    "device": {
      "device_type_id": "1",
      "name": "equipo",
      "imei_uid": "2022202220222022",
      "brand_id": "1",
      "model_id": "1",
      "time_zone_id": "16",
      "unlink_vehicle": "2023-01-01"
    },
    "sim": {
      "name": "nombre",
      "company_id": "1",
      "phone_number": "12345678900",
      "nip_number": "123456"
    },
    "IdSensors_template": 1415
  }
]' \
--data-urlencode 'apikey=f77c31ce81907cc5f0ecffeda60fb4f6'
Respuesta de ejemplo:
{
    "status": 200,
    "data": {
        "client": "Se creo el cliente apiprod1201",
        "users": [
            "Se creo el usuario nombre usuario",
            "Se creo el usuario nombre usuario"
        ],
        "sim": [
            "Se creo la sim nombre"
        ],
        "device": [
            "Se creo el equipo 2022202220222022"
        ],
        "assets": [
            "Se creo el vehiculo activo"
        ]
    }
}
Ver campos de respuesta:
Campo

Descripción

 Tipo
client

Descripción cliente creado

 JSON
users

Listado usuarios creados

 JSON
sim

Listado tarjetas creadas

 JSON
device

Listado equipos creados

 JSON
assets

Listado activos creados

 JSON
 
Volver arriba