Statistics API

Qué es Statistics API

La Statistics API permite al usuario obtener estadísticas de su cuenta.

Puntos clave

Para acceder a la API necesitas tus credenciales de acceso (usuario y contraseña) que encontrarás aquí.

Métodos y ejemplos

Los ejemplos están escritos en sentencias CURL. Puedes convertir las sentencias CURL a PHP usando esta página web. Para otros lenguajes de programación deberás utilizar una librería CURL correspondiente.

get_received_payments

Obtener una lista de tus pagos recibidos.

Ejemplo

curl https://bitbooklite.com/api/v2/?apiUser=00000-AAAAA-00000-AAAAA-00000&apiPassword=000000-AAAAAA-000000-AAAAAA-000000
        -d 'api_consult_type=get_received_payments'
        -d 'operation_data={"limit":10}'

Endpoint

https://bitbooklite.com/api/v2/

GET parameters

apiUser (obligatorio - string): Usuario de tu credencial de acceso API.
apiPassword (obligatorio - string): Contraseña de tu credencial de acceso API.

POST parameters

api_consult_type (obligatorio - string): Método de la API, en este caso, "get_received_payments".
operation_data (obligatorio - json encoded array):
- limit (obligatorio - integer): Limite de elementos a obtener (máximo 500).
- limitStart (opcional - integer): Inicio del límite, útil para paginación de resultados. DEFAULT = 0
- orderBy (opcional - string): Columna por la que ordenar los resultados. Valores admitidos: ["id", "cantidad", "fecha"]. DEFAULT = "id"
- orderMode (opcional - string): Modo de ordenar los resultados. Valores admitidos: ["ASC", "DESC"]. DEFAULT = "DESC"
- processor (opcional - string): Si se envía, solo se retornarán resultados con este procesador de pagos.

Valores devueltos

JSON


            {
                "error":false,
                "errores":[],
                "answer":{
                    "payments":[
                        {
                            "id":170,
                            "amount":105.26,
                            "amount_formated":"105,26",
                            "currency":"USD",
                            "book_id":1523,
                            "date":"2023-05-15 21:20:31",
                            "date_formated":"16/05/2023 00:20:31 GMT+0",
                            "processor":"paypal_unique",
                            "processor_fee":5.263,
                            "platform_fee":10.526,
                        }
                    ]
                }
            }

error (obligatorio - boolean): "true" en caso de error.
errores (obligatorio - array): Conjunto de strings con los errores producidos, si existen.
answer (obligatorio - array): respuesta del servidor.
- payments (obligatorio - array): lista de pagos recibidos.
  - id (obligatorio - integer): ID del pago.
  - amount (obligatorio - float): monto del pago.
  - currency (obligatorio - string): moneda del pago.
  - book_id (obligatorio - integer): ID del libro vendido.
  - processor (obligatorio - string): Nombre del procesador de pagos.
  - processor_fee (opcional - float): Monto de la comisión del procesador de pagos.
  - platform_fee (opcional - float): Monto de la comisión de BitBook Lite.
  - ...

get_received_payments_stats

Obtener estadísticas de tus pagos recibidos.

Ejemplo

curl https://bitbooklite.com/api/v2/?apiUser=00000-AAAAA-00000-AAAAA-00000&apiPassword=000000-AAAAAA-000000-AAAAAA-000000
        -d 'api_consult_type=get_received_payments_stats'
        -d 'operation_data={"interval":"day","regression":30}'

Endpoint

https://bitbooklite.com/api/v2/

GET parameters

apiUser (obligatorio - string): Usuario de tu credencial de acceso API.
apiPassword (obligatorio - string): Contraseña de tu credencial de acceso API.

POST parameters

api_consult_type (obligatorio - string): Método de la API, en este caso, "get_received_payments_stats".
operation_data (obligatorio - json encoded array):
- interval (obligatorio - string): Intervalo de tiempo. Debe ser uno de estos valores: ["day", "month"].
- regression (obligatorio - integer): Número de pasos regresivos del intervalo de tiempo. Ejemplo: si interval es "day" y regression es 10, se retornarán las estadísticas de los últimos 10 días.

Valores devueltos

JSON


            {
                "error":false,
                "errores":[],
                "answer":{
                    "results":[
                        {
                            "total":2,
                            "init_date":"2023-05-23 00:00:00",
                            "end_date":"2023-05-22 00:00:00",
                            "payments":[
                                {
                                    "id":170,
                                    "amount":105.26,
                                    "amount_formated":"105,26",
                                    "currency":"USD",
                                    "book_id":1523,
                                    "date":"2023-05-15 21:20:31",
                                    "date_formated":"16/05/2023 00:20:31 GMT+0",
                                    "processor":"paypal_unique",
                                    "processor_fee":5.263,
                                    "platform_fee":10.526,
                                },
                                {
                                    "id":171,
                                    "amount":105.26,
                                    "amount_formated":"105,26",
                                    "currency":"USD",
                                    "book_id":1556,
                                    "date":"2023-05-15 21:20:31",
                                    "date_formated":"16/05/2023 00:20:31 GMT+0",
                                    "processor":"paypal_unique",
                                    "processor_fee":5.263,
                                    "platform_fee":10.526,
                                },
                            ],
                        }
                    ]
                }
            }

error (obligatorio - boolean): "true" en caso de error.
errores (obligatorio - array): Conjunto de strings con los errores producidos, si existen.
answer (obligatorio - array): respuesta del servidor.
- results (obligatorio - array): lista de datos de cada intervalo.
  - total (obligatorio - integer): Número de pagos recibidos en este período.
  - init_date (obligatorio - string): Fecha de inicio de este período.
  - end_date (obligatorio - string): Fecha de final de este período.
  - payments (obligatorio - array): Lista de pagos recibidos en este período.

Volver atrás

New post

Categorías del post

Qué es Statistics API

Puntos clave

Métodos y ejemplos

get_received_payments

Ejemplo

Endpoint

GET parameters

POST parameters

Valores devueltos

get_received_payments_stats

Ejemplo

Endpoint

GET parameters

POST parameters

Valores devueltos