Saltar al contenido principal

Respuesta exitosa y Respuesta fallida

Al momento de consumir un servicio de la API web de AceptaBits es importante saber si la respuesta a dicho consumo fue exitosa o fue fallida, a continuación te explicaremos como identificarlas

Respuesta exitosa​

El primer indicador de que una petición fue exitosa será el código de status HTTP, en AceptaBits sabrás que una respuesta fue exitosa si obtienes el código de status 200:

código de status HTTP 200 = petición exitosa al servidor de AceptaBits

El siguiente indicador de que una petición fue exitosa será revisar el JSON de respuesta que retornara el consumo del servicio, esta respuesta contendrá un campo llamado status, si este campo contiene el valor true, significa que la petición fue exitosa y el consumo del servicio se realizó correctamente, veamos el ejemplo de respuesta al consumir el servicio de get-currencies:


{
    "status": true,
    "success": {
        "code": "0000"
    },
    "data": [
        {
            "name": "PesoBits",
            "code": "PBT",
            "color": "#029400",
            "buy_mxn_price": "2.84000000"
        },
        {
            "name": "Bitcoin",
            "code": "BTC",
            "color": "#F7931B",
            "buy_mxn_price": "1156067.51000000"
        }
    ]
}

Todas las respuestas exitosas en el API web de AceptaBits tendrán una estructura como esta, es importante para el desarrollador conocerla y saber qué hacer con la información obtenida.

Analicemos la respuesta y veamos cada uno de sus elementos
  • El primer elemento a observar en este JSON, es que contiene el campo status con el valor true, esto nos indica que el consumo se realizó correctamente.
  • También podemos observar un campo llamado success que a su vez contiene un campo con el nombre code con el valor 0000, este código es único y cada servicio tiene el suyo, en este caso significa que el listado de monedas se obtuvo de manera correcta.
  • Después tenemos un campo que se llama data, en este campo encontraras la información que ha retornado el servicio, cada servicio retornada información diferente, en este caso podemos ver la lista de monedas con las que trabaja la pasarela de pagos de AceptaBits como respuesta al haber consumido el servicio de get-currencies.

Ahora que se conoce la estructura de una respuesta exitosa, dependerá del desarrollador como implementarla y qué hacer con la información obtenida al consumir el servicio.

NOTAS

Antes de continuar aquí tienes algunos puntos importantes a tener en cuenta:

  • El campo code que se encuentra dentro de success es único para cada servicio, dentro de la documentación de cada uno de los servicios encontraras dicho código y cuál es su significado, esto resulta bastante útil si pretendes mostrar el significado en tu implementación o simplemente para que conozcas su significado.

  • El campo data contiene la información perteneciente a cada uno de los servicios, por lo tanto, cada servicio retornara información diferente, puedes encontrar la información que retorna cada servicio en su respectiva documentación.

  • La respuesta que retorna cada servicio está en formato JSON, por lo que deveras de hacer las adecuaciones que necesites dentro de tu proyecto para poder manipular la respuesta.

  • Las peticiones que realices podrán ser consultadas en el HISTORIAL DE LLAMADAS que se encuentra dentro de Gestión de API en tu cuenta de AceptaBits, para más información de esta sección ingresa en el siguiente enlace: Historial de llamadas

Para finalizas con estas notas, te recordamos que puedes encontrar la información completa de cada uno de los servicios en su respectiva documentación, solo debes ingresar en el siguiente enlace: Lista de métodos API

Respuesta fallida​

El primer indicador de que una petición fue fallida será el código de status HTTP, en AceptaBits sabrás que una respuesta fue fallida si obtienes un código de status que no sea el 200, por ejemplo:

código de status HTTP 400 = petición errónea, puede ser que un parámetro no este correcto
código de status HTTP 401 = petición errónea, fallo la autenticación de tu Token API
código de status HTTP 500 = petición errónea, ocurrió un error interno en AceptaBits

En resumen, si tu código de respuesta NO fue el 200 significa que algo está mal.

El siguiente indicador de que una petición fue fallida será revisar el JSON de respuesta que retornara el consumo del servicio, esta respuesta contendrá un campo llamado status, si este campo contiene el valor false, significa que la petición fue fallida y el consumo del servicio no se realizó correctamente, veamos el ejemplo de respuesta al consumir el servicio de add-product y resulto en una petición errónea:


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

Todas las respuestas fallidas en el API web de AceptaBits tendrán una estructura como esta, es importante para el desarrollador conocerla y saber qué hacer con la información obtenida.

Analicemos la respuesta y veamos cada uno de sus elementos
  • El primer elemento a observar en este JSON, es que contiene el campo status con el valor false, esto nos indica que el consumo ha fallado.
  • También podemos observar un campo llamado error que a su vez contiene un campo con el nombre code con el valor 1209, este código es único y cada servicio tiene su propia lista de códigos de error, en este caso significa que: el nombre es requerido, es decir, al momento de realizar esta petición para este ejemplo no se envió el parámetro name con su respectivo valor, supongamos que queremos dar de alta un producto que se llama calculadora de mano, en ese caso deberíamos de enviar el parámetro name con el valor calculadora de mano, al no enviarlo obtenemos una respuesta fallida, y dicha respuesta no indica que hace falta el parámetro name gracias a que podemos observar el código de error 1209.

Ahora que se conoce la estructura de una respuesta fallida, dependerá del desarrollador como implementarla y qué hacer con la información obtenida al consumir el servicio.

NOTAS

Antes de continuar aquí tienes algunos puntos importantes a tener en cuenta:

  • El campo code que se encuentra dentro de error es único para cada servicio, dentro de la documentación de cada uno de los servicios encontraras su respectivo listado de códigos de error y cuáles son las causas, esto es muy útil para que los desarrolladores sepan que fue lo que fallo y por ende saber cómo corregirlo.

  • La respuesta que retorna cada servicio está en formato JSON, por lo que deveras de hacer las adecuaciones que necesites dentro de tu proyecto para poder manipular la respuesta.

  • Las peticiones que realices podrán ser consultadas en el HISTORIAL DE LLAMADAS que se encuentra dentro de Gestión de API en tu cuenta de AceptaBits, para más información de esta sección ingresa en el siguiente enlace: Historial de llamadas

Para finalizar con estas notas, te recordamos que puedes encontrar la información completa de cada uno de los servicios en su respectiva documentación, solo debes ingresar en el siguiente enlace: Lista de métodos API

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