Crear un cliente

Esta operación le permite crear un subcliente para su cuenta. Para crear un subcliente, debe tener saldo disponible.

Nota

Es necesario consultar con comercial el saldo mínimo requerido para configurar la cuenta de un subcliente.

Solicitud HTTP

POST /clients

Parámetros del encabezado

Encabezado	Descripción
Authorization  requerida	El bearer token creado en Obtener token de autorización
Content-Type requerido	application/json

Parámetros de cuerpo

Parámetro	Tipo	Patrón	Descripción
name requerido	cadena	5-30 caracteres	El nombre de la empresa a crear
alias  requerido	cadena	3-10 caracteres	Alias de la empresa a crear
email  requerido	cadena	correo electrónico	Correo electrónico principal de la empresa
availabe  requerido	flotante	número flotante	Disponible inicialmente para la empresa
phone requerido	cadena	10 dígitos	Teléfono principal de la empresa
mobile_phone requerido	cadena	10 dígitos	Teléfono móvil principal de la empresa
rfc  requerido	cadena	10-13 caracteres	RFC de la empresa a crear
street requerido	cadena	1-20 caracteres	Nombre de la calle donde está ubicada la empresa
ext_street_number requerido	cadena	1-5 caracteres	Número de calle externo donde se ubica la empresa
int_street_number  opcional	cadena	1-5 caracteres	Número de calle interna donde se ubica la empresa
suburb requerido	cadena	1-25 caracteres	Suburbio donde se ubica la empresa
township  requerido	cadena	1-25 caracteres	Municipio donde está ubicada la empresa
city  requerida	cadena	1-25 caracteres	Ciudad donde está ubicada la empresa
state  requerido	cadena	Estados	La dirección del estado de la empresa. Consulte los valores permitidos en Obtener catálogo de estados
postal_code  requerido	cadena	5 dígitos	Código postal donde está ubicada la empresa
contact_name requerido	cadena	1-12 caracteres	El nombre del contacto principal de la empresa.
contact_second_name  opcional	cadena	1-12 caracteres	El segundo nombre del contacto principal de la empresa.
contact_surname requerido	cadena	1-12 caracteres	El apellido del contacto principal de la empresa.
contact_second_surname opcional	cadena	1-12 caracteres	El segundo apellido del contacto principal de la empresa.
contact_email requerido	cadena	correo electrónico	El correo electrónico del contacto principal de la empresa.
contact_telephone_country_code requerido	cadena	2-3 dígitos	El código telefónico del país del contacto principal de la empresa
contact_telephone requerido	cadena	10 dígitos	El teléfono del contacto principal de la empresa.
contact_mobile_phone_country_code requerido	cadena	2-3 dígitos	El código de país del teléfono móvil del contacto principal de la empresa
contact_mobile_phone requerido	cadena	10 dígitos	El teléfono móvil del contacto principal de la empresa.
legal_representative_name opcional	cadena	1-12 caracteres	El nombre del representante legal de la empresa.
legal_representative_second_name opcional	cadena	1-12 caracteres	El segundo nombre del representante legal de la empresa.
legal_representative_surname opcional	cadena	1-12 caracteres	El apellido del representante legal de la empresa.
legal_representative_second_surname opcional	cadena	1-12 caracteres	El segundo apellido del representante legal de la empresa.
legal_representative_email opcional	cadena	correo electrónico	El correo electrónico del representante legal de la empresa
legal_representative_telephone_country_code opcional	cadena	2-3 dígitos	El código telefónico del país del representante legal de la empresa
legal_representative_telephone opcional	cadena	10 dígitos	El teléfono del representante legal de la empresa
legal_representative_mobile_phone_country_code opcional	cadena	2-3 dígitos	El código de país del teléfono móvil del representante legal de la empresa
legal_representative_mobile_phone opcional	cadena	10 dígitos	El teléfono móvil del representante legal de la empresa
api_key_name requerido	cadena	5-30 caracteres	Nombre de la clave API de la empresa que se va a crear
api_key_description  opcional	cadena	1-30 caracteres	Descripción de la clave API
api_key_password requerido	cadena	1-30 caracteres	El acceso al servicio web de contraseñas de la clave API

Ejemplo de solicitud JSON:

{
  "name": "Noentiendo",
  "alias": "NOENT",
  "email": "[email protected]",
  "available": 1000,
  "phone": "5555555555",
  "mobile_phone": "6666666666",
  "rfc":  "AAMM9001010A1",
  "street": "Av. Siempre",
  "ext_street_number": "1234",
  "int_street_number": "Apt.4",
  "suburb": "Nápoles",
  "township": "Benito Juarez",
  "city": "CDMX",
  "state": "CDMX",
  "postal_code": "55555",
  "contact_name": "Juan",
  "contact_second_name": "Alberto",
  "contact_surname": "Perea",
  "contact_second_surname": "Perez",
  "contact_email": "[email protected]",
  "contact_telephone_country_code": 52,
  "contact_telephone": "5555555555",
  "contact_mobile_phone_country_code": 52,
  "contact_mobile_phone": "6666666666",
  "legal_representative_name": "Iman",
  "legal_representative_second_name": "Hora",
  "legal_representative_surname": "Martinez",
  "legal_representative_second_surname": "Martinez",
  "legal_representative_email": "[email protected]",
  "legal_representative_telephone_country_code": 52,
  "legal_representative_telephone": "5555555555",
  "legal_representative_mobile_phone_country_code": 52,
  "legal_representative_mobile_phone": "6666666666",
  "api_key_name": "SUB_CLIENT_ACCESS",
  "api_key_description": "Subclient Api Key",
  "api_key_password": "12345"
}

Ejemplo de respuesta JSON:

{
  "success": true,
  "code": 0,
  "message": "OK",
  "data": {
    "subclient": {
      "id": "12345abc-ebb5-56d8-3256-9875672a3455",
      "code": "NOENT",
      "name": "Noentiendo",
      "available": 1000,
      "rfc": "AAMM9001010A1",
      "api_client": {
        "id": "",
        "name": "54321abc-abc5-56d8-6987-9875672a6587",
        "alias": "NOENT",
        "description": "Subclient Api Key"
      }
    }
  }
}