Como usar el Swagger

Nuestro Api Rest y Botón de pagos se encuentran documentados en una especificación abierta conocida como Swagger. Nuestra documentación swagger describe la lista de recursos disponibles, sus operaciones y parámetros, especificando el nombre y tipo, si los parámetros son necesarios u opcionales, e información sobre los valores aceptables para estos parámetros. Además, incluye un esquema JSON que describe la estructura del cuerpo de la solicitud, y el otro esquema JSON que describe la estructura de la respuesta de una operación.

ingresa en la dirección https://pay.payphonetodoesposible.com/swagger y sigue los siguientes pasos:

  1. Ingresar Token: Para usar el swagger y hacer las pruebas necesarias debes proporcionar tu token de autenticación (haz click aquí para obtener tu token de autenticación). Ingresa la palabra «Bearer » en la sección «api_key» seguido de tu token y presiona el botón «explore»:

Con esto garantizas que las llamadas realizadas desde el swagger cumplan con la seguridad requerida.

2. Uso del swagger: Tendrás acceso a cada método y podrás consultar sus diferentes llamadas, sus modelos  de solicitud, respuesta y el detalle de sus campos.

También puedes ingresar los parámetros en el área de texto en formato Json y haciendo click en el botón “Try it out” podrás hacer una petición real al servicio y comprobar su funcionamiento.

Para consultar el significado de los campos, su tipo y si son obligatorios haz click en el botón model:

Leave A Comment?