Distribución de los métodos API
Los métodos del API web de AceptaBits se distribuyen en cada uno de los elementos principales de la plataforma como lo son tiendas o clientes, por mencionar un par de ejemplos, el listado de métodos disponibles para la gestión de cada uno de ellos se mostrara a continuación, junto con un enlace a su respectiva documentación individual.
Los elementos principales de AceptaBits son los siguientes:
- Monedas
- Tiendas
- Sucursales
- Productos
- Servicios
- Agentes
- Clientes
- Órdenes de venta
La explicación a detalle de que es, para que sirven y/o cómo funcionan todos los elementos principales de AceptaBits podrás encontrarla dentro de la sección de Introducción, es muy importante estar familiarizado con todos estos elementos antes de iniciar a consumir los servicios de la API web para poder despejar la mayor cantidad de dudas.
Por ejemplo, para crear una orden de venta es necesario tener previamente generado un cliente, cliente que a su vez está ligado a una tienda que previamente debiste de haber generado, también es necesario en las órdenes de venta tengan en su carrito por lo menos un producto o un servicios, los cuales también deben de estar previamente generados y ligados a la misma tienda a la que pertenece el cliente.
Este tipo de detalles pueden llegar a confundir al desarrollador si no se tiene el conocimiento previo, para eso recomendamos AMPLIAMENTE LEER TODAS LAS SECCIONES de la presente documentación, sobre todo como ya lo mencionamos, leer con atención la sección de Introducción para entrar en contexto sobre todos los elementos que componen la plataforma.
Monedas
Las monedas son uno de los 3 elementos principales al momento de crear una orden de venta (junto con los clientes y producto/servicio), por lo que es importante saber cuáles son soportadas por la pasarela de pagos, para ellos utilizaremos lo siguiente:
| Método API | Descripción |
|---|---|
| get-currencies | Este método permite obtener el listado de monedas soportadas por la pasarela de pagos, así como su respectiva información |
Códigos telefónicos por país
Los códigos telefónicos por país son un elemento importante a la hora de dar de alta agentes de venta, esto es debido a que para dar de alta un agente se necesita ingresar un numero de teléfono valido de 10 dígitos acompañado del código telefónico del país, por lo que es importante saber cuáles códigos son soportados en la plataforma, para ellos utilizaremos lo siguiente:
| Método API | Descripción |
|---|---|
| get-phone-country-codes | Este método permite obtener el listado de códigos telefónicos de cada país soportados en la plataforma, su principal uso se encuentra al momento de dar de alta agentes de ventas |
Generales de consulta
Los métodos generales de consulta son métodos en los cuales podremos obtener información relevante de la plataforma, como por ejemplo, el número de confirmaciones de red que requiere cada moneda para los depósitos que provienen de una wallet externa a MercadoBits.
Para el ejemplo mencionado y demás información relevante utilizaremos lo siguiente:
| Método API | Descripción |
|---|---|
| get-payment-data | Este método permite obtener el listado de monedas soportadas por la pasarela de pagos y el número de confirmaciones de red que requiere cada una de ellas, también se obtiene el tiempo de expiración en minutos que se utiliza en las órdenes de venta |
| get-commission_percent | Este método muestra el porcentaje de comisión que la plataforma AceptaBits cobra en las órdenes de venta por el uso del servicio |
Tiendas
Las tiendas son la columna principal de la plataforma, ya que a ellas estará ligado prácticamente todo, como por ejemplo, las órdenes de venta y productos, por mencionar algunos ejemplos, el listado de métodos disponibles para su gestión es el siguiente:
| Metodo API | Descripcion |
|---|---|
| get-shops | Este método permite obtener el listado de tiendas que tiene el usuario y su respectiva información |
| add-shop | Este método permite crear tiendas nuevas |
| edit-shop | Este método permite editar tiendas previamente creadas |
| show-shop | Este método permite obntener la información de una tienda en específico, a diferencia de get-shops que entrega un listado completo |
| delete-shop | Este método permite eliminar una tiendas previamente creada |
Productos
Los productos son uno de los 3 elementos principales al momento de crear una orden de venta (junto con los clientes y las monedas), por lo que es importante saber cómo generarlos, obtenerlos y/o eliminarlos, el listado de métodos disponibles para su gestión es el siguiente:
| Método API | Descripción |
|---|---|
| get-products | Este método permite obtener el listado de productos que tiene el usuario dados de alta, así como su respectiva información |
| add-product | Este método permite crear productos nuevos |
| edit-product | Este método permite editar productos previamente creados |
| show-product | Este método permite obtener la información de un producto en específico, a diferencia de get-products que entrega un listado completo |
| delete-product | Este método permite eliminar un producto previamente creado |
Servicios
Los servicios son uno de los 3 elementos principales al momento de crear una orden de venta (junto con los clientes y las monedas), por lo que es importante saber cómo generarlos, obtenerlos y/o eliminarlos, el listado de métodos disponibles para su gestión es el siguiente:
| Método API | Descripción |
|---|---|
| get-services | Este método permite obtener el listado de servicios que tiene el usuario dados de alta, así como su respectiva información |
| add-service | Este método permite crear servicios nuevos |
| edit-service | Este método permite editar servicios previamente creados |
| show-service | Este método permite obtener la información de un servicio en específico, a diferencia de get-services que entrega un listado completo |
| delete-service | Este método permite eliminar un servicio previamente creado |
Clientes
Los clientes son uno de los 3 elementos principales al momento de crear una orden de venta (junto con las monedas y producto/servicio), por lo que es importante saber cómo generarlos, obtenerlos y/o eliminarlos, el listado de métodos disponibles para su gestión es el siguiente:
| Método API | Descripción |
|---|---|
| get-customers | Este método permite obtener el listado de clientes que tiene el usuario y su respectiva información |
| add-customer | Este método permite crear clientes nuevos |
| edit-customer | Este método permite editar clientes previamente creados |
| show-customer | Este método permite obtener la información de un cliente en específico, a diferencia de get-customers que entrega un listado completo |
| delete-customer | Este método permite eliminar un cliente previamente creada |
Agentes
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 de la cuenta, el listado de métodos disponibles para su gestión es el siguiente:
| Método API | Descripción |
|---|---|
| get-agents | Este método permite obtener el listado de agentes que tiene el usuario y su respectiva información |
| add-agent | Este método permite crear agentes nuevos |
| edit-agent | Este método permite editar agentes previamente creados |
| show-agent | Este método permite obtener la información de un agente en específico, a diferencia de get-agents que entrega un listado completo |
| delete-agent | Este método permite eliminar un agente previamente creado |
Sucursales
Las sucursales son una extensión de las tiendas, su principal función es mostrar más resultados en el buscador de Dónde puedo pagar con AceptaBits?, es decir, a las sucursales se les puede asignar una dirección diferente, un email de contacto diferente, un teléfono de contacto diferente y una ubicación diferente(latitud y longitud en coordenadas) a las que tiene la tienda originalmente, por ejemplo, supongamos que tienes una tienda principal llamada Tortillería la montaña y esta está ubicada en Guadalajara jalisco, pero al mismo tiempo tienes una sucursal ubicada en Zapopan jalisco, cuando una persona haga una búsqueda de tortillerías podrá localizar tu negocio en las dos ubicaciones gracias a las sucursales.
Es importante mencionar que más allá de mostrar más resultados de búsqueda, no tienen otra funcionalidad principal, por ejemplo, las órdenes de venta no son asignables a una sucursal y siempre estarán ligadas a tu tienda principal, que en el ejemplo anterior seria Tortillería la montaña que está en Guadalajara, si lo que necesitas es tener tus órdenes de venta separadas, entonces lo que te recomendamos es que en lugar de dar de alta una sucursal, des de alta una nueva tienda, y cambiarles el nombre, por ejemplo, tu tienda principal que se llama Tortillería la montaña ahora podrías llamarla Tortillería la montaña - Guadalajara y a tu nueva tienda llamarla Tortillería la montaña - Zapopan, esto es solo una recomendación pero dependerá del dueño de la cuenta en AceptaBits como realizar la gestión de sus operaciones de venta.
El listado de métodos disponibles para la gestión de las sucursales es el siguiente:
| Método API | Descripción |
|---|---|
| get-shop-branches | Este método permite obtener el listado de sucursales de una tienda que tiene el usuario y su respectiva información |
| add-shop-branch | Este método permite crear sucursales nuevas |
| edit-shop-branch | Este método permite editar sucursales previamente creadas |
| show-shop-branch | Este método permite obtener la información de una sucursal en específico, a diferencia de get-agents que entrega un listado completo |
| delete-shop-branch | Este método permite eliminar una sucursal previamente creada |
Órdenes de venta
Las órdenes de venta son el elemento más importante en el flujo de pago en la plataforma de AceptaBits, son las encargadas de plasmar la información de un pago incluyendo la dirección de depósito, el total a pagar, el estado en el que se encuentra el pago y demás información importante, por mencionar algunos ejemplos.
Como ya se mencionó en la Introducción para poder generar una orden se requieren tener 3 elementos:
- Un cliente
- Un producto o un servicio
- Una moneda
Los cuales podremos encontrar como generarlos o encontrarlos en esta misma sección, así mismo el listado de métodos disponibles para la gestión de las órdenes es el siguiente:
| Método API | Descripción |
|---|---|
| get-orders | Este método permite obtener el listado de órdenes de venta que tiene el usuario y su respectiva información |
| add-order | Este método permite crear una orden de venta nueva |
| calculate-order | Este método permite realizar el calculo de una orden previo a crearla (útil para hacer el cálculo de los productos y servicios ingresados en MXN a la criptomoneda de la orden) |
| show-order | Este método permite obtener la información de una orden en específico, a diferencia de get-orders que entrega un listado completo |
| show-order-customer | Este método a diferencia del anterior muestra la información de la orden pero con la dirección de depósito ya generada y con el tiempo de expiración ya corriendo, este es el método que se debe de utilizar para mostrar la orden de venta al cliente final y que pueda pagar |
| simulate-payment-order | Este método permite simular el pago de una orden, la simulación permite que se pague como un usuario de MercadoBits (pagos instantáneos) o como si proviniera de una wallet externa u otra plataforma ajena a MercadoBits (simula confirmaciones de red), solo esta disponible para su uso en el ambiente SANDBOX DE PRUEBAS |