edit-agent

Este método se utiliza para editar un agente, ya sea para cambiar el nombre, email o algún otro dato que contiene el agente.

NOTAS

En el caso de los agentes, todos son editables a menos que exista un caso especial que no lo sea, por lo tanto y teniendo en cuenta lo anterior, este método solo es funcional para los agentes que tengan el campo isEditable con valor -1.

Path del método

edit-agent

Endpoint final

PRODUCCION

https://aceptabits.com/api/thirdparty/v1/edit-agent

SANDBOX DE PRUEBAS

https://sandbox.aceptabits.com/api/thirdparty/v1/edit-agent

Método de petición HTTP

POST

Lista de parámetros

Parámetro	Obligatorio	Descripción	valor
code	Si	El código del agente que se quiere editar	Ejemplo: pgbage158415559613587461 Deveras de ingresar el código del agente que requieres editar, el código debe de ser de un agente editable Este código es único y puedes encontrarlo al consultar la información de un agente dentro de los métodos get-agents o show-agent
active_account	SI	Es el estado de la cuenta del agente, es decir, si la cuenta esta activa o no está activa para el inicio de sesión y uso de la plataforma	Se aceptan dos valores el 0 y el -1: 0 = el agente no tiene activa su cuenta -1 = el agente si tiene activa su cuenta
name	No	Es el nombre que se le asignara al agente	ejemplo: Juan Carlos, Martin, Fernanda, etc. Deberas de ingresar el nombre con el que requieres que el agente se edite
lastname	No	Es el o los apellidos que le asignaras al agente	ejemplo: Gomez Sanchez, Torres, etc. Deveras de ingresar el o los apellidos con el que requieres que el agente se edite
email	No	Es el email que se le asignara al agente	ejemplo: juan@ejemplo.com, negocio@outlook.mx, etc. Deveras de ingresar el email con el que requieres que el agente se edite, este email es el que será utilizado para que el agente pueda iniciar sesión dentro de la plataforma, debe de ser un email valido y funcional ya que se requiere enviar un código de verificación al momento de que el agente genere su PIN DE SEGURIDAD o decida cambiarlo
phone_contry_code	No	Es el código telefónico del país	ejemplo: +52, 52, +1, 1, etc. Deveras de ingresar un código telefónico de los países soportados en la plataforma, para poder obtener el listado de los códigos telefónicos disponibles consulta el método: get-phone-country-codes El código puede ingresarse con o sin el signo de `+`, por ejemplo, para México se puede enviar de la siguiente manera: `+52` o simplemente `52`
phone	No	El número de teléfono que se le asignara al agente	ejemplo: 3333333333, etc. Deveras de ingresar el número de telefono con el que requieres que el agente se edite, debe de ser numérico de 10 dígitos, no se aceptan espacios o caracteres que no sean numéricos, este número de teléfono es el que será utilizado para que el agente pueda iniciar sesión dentro de la plataforma, se combina con el campo `phone_contry_code` para formar el número de teléfono final del agente
password	No	Es la contraseña que se le asignara al agente	ejemplo: agente98, @sales9645, etc. Deveras de ingresar una contraseña segura de al menos 8 caracteres, se admite una cadena de caracteres alfanuméricos, es sensible a símbolos, mayúsculas y minúsculas La contraseña no estará disponible para su consulta una vez que el agente sea editado, por lo tanto deveras de recordarla y dársela a tu agente de manera directa, si se requiere cambiar por que se ha olvidado o solo por seguridad, se tendrá que cambiar desde la plataforma con el usuario maestro de la cuenta de AceptaBits en la sección de AGENTES o por medio de este mismo método edit-agent

NOTAS

Si se envía el parámetro name con un valor vacío, el nombre actual del agente se mantendrá.
Si se envía el parámetro lastname con un valor vacío, el nombre actual del agente se mantendrá.
Si se requiere cambiar el número de teléfono se deberán de enviar los parámetros phone_contry_code y phone al mismo tiempo, si se envía uno solo no tendrá efecto la edición, esto es debido a que los campos phone_contry_code y phone se unifican para generar el número de teléfono final del agente.
Si se envía el parámetro password (es decir, una nueva contraseña), no estará disponible para su consulta una vez que el agente sea editado, por lo tanto deveras de recordarla y dársela a tu agente de manera directa, también puedes cambiar la contraseña del agente utilizando al usuario de la cuenta maestra de AceptaBits desde la sección de AGENTES, también te recordamos que los propios agentes no pueden cambiar sus credenciales de inicio de sesión (el email, el número de teléfono y la contraseña), ni siquiera pueden hacerlo desde su perfil de usuario, la gestión completa de los agentes es exclusiva del usuario de la cuenta maestra de AceptaBits por medio de la Plataforma o utilizando la API web.
El email y número de teléfono son únicos para cada agente, por lo que no se pueden ingresar emails o número de teléfono que ya se tengan dados de alta, si se ingresan ocasionara el código ERROR 1270.

Lista de códigos

Exitoso

Código	Descripción
0050	El agente se ha actualizado con éxito

Error

Código	Descripción
0000	El Token API no es correcto y la autenticación del usuario ha fallado
0003	El Token API no es correcto y la autenticación del usuario ha fallado
1255	El Token API no es correcto y la autenticación del usuario ha fallado
1256	El código del agente es requerido
1260	El email del agente debe de ser un email valido
1262	El número de teléfono del agente debe de ser de 10 dígitos
1263	El número de teléfono del agente debe de ser de 10 dígitos
1265	La Contraseña debe contener al menos 8 caracteres
1266	El estado de la cuenta es requerido
1267	El estado de la cuenta debe de ser un estado valido (cuenta activa o cuenta no activa)
1268	El agente que se intenta editar no existe (el código del agente es incorrecto)
1334	No es posible editar al agente, el código del agente ingresado debe de corresponder a un agente que sea editable
1269	El Token API no es correcto y la autenticación del usuario ha fallado
1270	El email o número de teléfono no pueden ser utilizados, se requiere ingresar un email o número de teléfono diferente
1271	Ocurrió un problema al editar el agente, inténtelo nuevamente o consulte con soporte técnico para más ayuda
1272	Ocurrió un problema al editar el agente, inténtelo nuevamente o consulte con soporte técnico para más ayuda

Ejemplo de respuesta EXITOSA

Exitoso

Código HTTP 200

{
    "status": true,
    "success": {
        "code": "0050"
    },
    "data": {
        "code": "pgbage15841555231594188",
        "name": "Mariano",
        "lastname": "Chavez Re.",
        "email": "alfondoC3@mail.com",
        "phone": "+523333333335",
        "created_at": "2024-08-09T22:25:17.000000Z",
        "created_at_format": "2024-08-09 17:25:17",
        "code_shop": "pgbsho40996222369461182",
        "name_shop": "Tienda general",
        "total_customers": 1,
        "total_orders": 0,
        "active_account": "0",
        "isEditable": "-1"
    }
}

Descripción de la respuesta

Revisar el listado de códigos EXITOSO para conocer el significado de success code.
data - muestra la información del agente
- code - Código del agente (este código es único para cada agente dado de alta)
- name - Nombre del agente
- lastname - Apellidos del agente
- email - Email del agente
- phone - Teléfono del agente
- created_at - Fecha y hora de creación del agente (UTC)
- created_at_format - Fecha y hora de creación del agente (America/Mexico_City)
- code_shop - Código de la tienda a la que pertenece el agente
- name_shop - Nombre de la tienda a la que pertenece el agente
- total_customers - Total de clientes asignados al agente
- total_orders - Total de órdenes de venta asignadas al agente
- active_account - indica si el agente tiene su cuenta activa en la plataforma (es decir, que pueda iniciar sesión y hacer uso de la plataforma), los valores posibles son:
  - 0 = el agente no tiene activa su cuenta
  - -1 = el agente si tiene activa su cuenta
- isEditable - indica si el agente se puede o no editar, los valores posibles son:
  - 0 = no se puede editar
  - -1 = si se puede editar

Ejemplo de respuesta FALLIDA

Error

Código HTTP 400, Código HTTP 401, Código HTTP 500

{
    "status": false,
    "error": {
        "code": "1266"
    }
}

Descripción de la respuesta

Revisar el listado de códigos ERROR para conocer la causa y saber cómo corregir
Si se obtiene un código HTTP 500 comunicarse a soporte tecnico
Si se obtiene un código HTTP 401 revisar que el Token API este correcto

Notas

Si tienes alguna duda recuerda que siempre puedes contactar con el equipo de soporte para desarrolladores ingresando en el siguiente enlace: Soporte para desarrolladores.

edit-agent

Path del método​

Endpoint final​

Método de petición HTTP​

Lista de parámetros​

Lista de códigos​

Ejemplo de respuesta EXITOSA​

Descripción de la respuesta​

Ejemplo de respuesta FALLIDA​

Descripción de la respuesta​

Path del método

Endpoint final

Método de petición HTTP

Lista de parámetros

Lista de códigos

Ejemplo de respuesta EXITOSA

Descripción de la respuesta

Ejemplo de respuesta FALLIDA

Descripción de la respuesta