Explore API's & Guides
En el Developer Hub de Novopayment, encontrarás la documentación de la API categorizada por casos de uso. Además, en cada sección de estas categorías, puedes acceder a la Referencia de la API, guías que explican varios usos de la API e incluso documentación de SDK.
En esta guía, explicaremos en detalle cómo acceder a la documentación de una API y sus puntos finales, así como lo que puedes encontrar en la documentación de cada uno.
Explore la Referencia de la API
Ve al menú principal y coloca el cursor sobre "Docs". Aparecerá un submenú que muestra los casos de uso más comunes junto con una breve descripción y la opción de acceder a la Referencia de la API, como se muestra en la siguiente imagen.
Haz clic en API Reference para el caso de uso que se ajuste a lo que estás buscando. Aquí encontrarás una explicación más detallada de este caso de uso, junto con todas las API correspondientes.
*Si no estás seguro acerca de tu caso de uso, no te preocupes. Siempre puedes explorar; este menú estará disponible para acceder fácilmente a todos los casos de uso y APIs. Además, puedes ir a la sección "Discover", donde puedes ver rápidamente todas las APIs, sus descripciones y filtrarlas por caso de uso.
Una vez que selecciones la referencia de la API, encontrarás una breve explicación de este caso de uso. Lee la descripción general y selecciona la API que necesitas en el lado izquierdo.
Operaciones - Referencia de API de Puntos Finales
Ahora encontrarás una breve explicación de la API, y puedes descubrir todos los puntos finales y esquemas de la API haciendo clic en el punto final que deseas explorar.
*También puedes descargar la documentación de referencia de la API en un archivo YAML de todas las APIs en un formato estándar de OpenAPI 3.0 haciendo clic en "Export".
Una vez que hayas seleccionado una operación o punto final, verás una descripción de la operación, documentación técnica, ejemplos de solicitud en diferentes lenguajes de programación, ejemplos de respuesta para cada código y ejemplos de códigos de error.
Sandbox
En el lado derecho de la documentación, encontrarás una sección de "sandbox", que puedes utilizar una vez que estés registrado, crees un proyecto en línea y obtengas un token de acceso. Puedes obtener más detalles en la guía "Get my access token".
En este sandbox, puedes ver y modificar el cuerpo de la solicitud, así como enviar la solicitud de la API y recibir una respuesta para comprender mejor la documentación.
Ejemplo de Solicitud
En el lado derecho de la documentación, justo debajo de la sección "sandbox", puedes ver y copiar el ejemplo de solicitud del punto final. Sin embargo, si necesitas este ejemplo en otros lenguajes, puedes hacer clic en "Request sample: Shell/Curl" y podrás verlo en lenguajes como JavaScript, Node.js, Python, Go, C, C#, Java, HTTP, Kotlin, PHP, R, Ruby, Swift y más.
Códigos de Respuesta y Ejemplo
Por último, al final de la documentación, siempre encontrarás los estados de respuesta, la estructura u objeto de respuesta junto con los detalles, y podrás ver ejemplos de respuesta.
Por defecto, verás el ejemplo de respuesta para el código de estado 200. Sin embargo, puedes ver el ejemplo para cada código de error para cualquier estado de respuesta siguiendo estos pasos:
- Primero, selecciona el código de estado que deseas ver en la sección "Responses".
- Luego, ve a la parte inferior derecha y haz clic en la casilla "Response Example". Esto mostrará todas las respuestas posibles disponibles para ese código de estado. Al seleccionar la que desees, podrás ver el ejemplo junto con su código, descripción y cuerpo (si corresponde).
Ahora que sabes lo que puedes encontrar en nuestro Developer Hub, es posible que desees considerar registrarte y crear un proyecto en línea, lo cual es completamente gratuito. Alternativamente, puedes ponerte en contacto con nuestro equipo de ventas para obtener más información.