add-agent

Este método se utiliza para dar de alta un nuevo agente en una tienda, no existe un límite y puede tener tantos agentes como lo requiera el usuario en cada una de las tiendas que tenga creadas.

NOTAS

Los agentes de venta son básicamente una extensión del usuario dueño de la cuenta de AceptaBits, su principal función es ser vendedores en la plataforma sin comprometer la integridad de la cuenta maestra, es decir, los agentes poseen sus propias credenciales para inicio de sesión y tienen la facultad de generar clientes y órdenes de venta para el usuario principal sin la necesidad de conocer las credenciales o iniciar sesión con la cuenta maestra del usuario.

Los agentes se comportan de la misma manera que un usuario normal, es decir, para dar de alta un agente se requiere de un email valido y funcional, un número de teléfono valido en el que recibirá los códigos de verificación para el inicio de sesión y una contraseña de al menos 8 caracteres.

El inicio de sesión de un Agente es similar al de un usuario normal, el único cambio que hay que hacer es seleccionar la opción Agente en lugar de la opción Usuario MercadoBits en el modal de inicio de sesión cuando pida que se Seleccione el tipo de inicio de sesión.

Dentro de la plataforma los ajetes al igual que los usuarios normales deberán de generar su propio PIN DE SEGURUDAD dentro de su perfil en la sección de SEGURIDAD, se hace esto para poder confirmar las acciones dentro de la plataforma al igual que lo haría un usuario normal.

Los agentes no puedo cambiar las credenciales de inicio de sesión, las cuales son el email, teléfono y contraseña, ni siquiera desde su propio perfil, la gestión de los agentes está reservada para el usuario maestro de la cuenta de AceptaBits desde la sección de AGENTES en la plataforma o por medio de la API web.

Path del método

add-agent

Endpoint final

PRODUCCION

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

SANDBOX DE PRUEBAS

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

Método de petición HTTP

POST

Lista de parámetros

Parámetro	Obligatorio	Descripción	valor
code_shop	Si	Es el código de la tienda a la que se asignara el cliente	ejemplo: pgbsho0635214789653205 Este código es único de cada tienda, se obtiene al consultar el listado de tiendas o al generar una tienda nueva, consulte los métodos: get-shops, add-shop o show-shop para mas detalles
name	Si	Es el nombre que se le asignara al agente	ejemplo: Juan Carlos, Martin, Fernanda, etc. Deveras de ingresar el nombre con el que requieres que el agente se genere
lastname	Si	Es el o los apellidos que le asignaras al agente	ejemplo: Gómez Sanchez, Torres, etc. Deveras de ingresar el o los apellidos con el que requieres que el agente se genere
email	Si	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 genere, 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	Si	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	Si	El número de teléfono que se le asignara al agente	ejemplo: 3333333333, etc. Deveras de ingresar el número de teléfono con el que requieres que el agente se genere, 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	Si	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 dado de alta, 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 del método edit-agent

NOTAS

Al momento de dar de alta al agente los campos phone_contry_code y phone se unifican para generar el número de teléfono final del agente, por ejemplo: si el código de teléfono del país fue el de México +52 y en el teléfono se ingresó 3333333333 significa que al consultar la información del agente se observara el campo phone de la siguiente manera: +523333333333.

La contraseña no estará disponible para su consulta una vez que el agente sea dado de alta, 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 del método edit-agent.

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 1254.

Se generara un nuevo cliente por default llamado Cliente agente General agente, este cliente se generara cada vez que se de alta un nuevo agente y estará ligado al agente recién creado, la función principal de este cliente es permitirle al agente generar órdenes de venta de manera rápida sin la necesidad de dar de alta un cliente inicial o un cliente nuevo cada vez que realice una venta, así mismo, al igual que cualquier otro cliente, este puede ser consultado utilizando los métodos de get-customers, show-customer o dentro de la plataforma en la sección de CLIENTES.

Para conocer más acerca de los elementos creados por default se deberá de consultar la sección: Elementos creados por default

Lista de códigos

Exitoso

Código	Descripción
0049	Agente creado 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
1238	El Token API no es correcto y la autenticación del usuario ha fallado
1239	El nombre del agente es requerido
1240	El o los apellidos del agente son requeridos
1241	El email del agente es requerido
1242	El email del agente debe de ser un email valido
1243	El número de teléfono del agente es requerido
1244	El número de teléfono del agente debe de ser de 10 dígitos
1245	El número de teléfono del agente debe de ser de 10 dígitos
1246	El código telefónico del país es requerido
1247	La Contraseña es requerida
1248	La Contraseña debe contener al menos 8 caracteres
1249	El código de la tienda es requerido
1250	La tienda a la que se asignara el agente no existe (código de tienda incorrecto)
1513	El código de país del número de teléfono debe de ser valido
1251	El Token API no es correcto y la autenticación del usuario ha fallado
1254	El email o número de teléfono no pueden ser utilizados, se requiere ingresar un email o número de teléfono diferente
1253	Ocurrió un problema y no es posible dar de alta al agente, inténtelo nuevamente o consulte con soporte técnico para más ayuda
1252	Ocurrió un problema y no es posible dar de alta al 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": "0049"
    },
    "data": {
        "code": "pgbage15841555231594188",
        "name": "Alfondo",
        "lastname": "Chavez R.",
        "email": "alfondoC2@mail.com",
        "phone": "+523333333334",
        "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": "-1",
        "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 recién creado
- 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 - Codigo 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": "1239"
    }
}

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 técnico
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.

add-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