API Reference
An API reference provides a broad understanding of how an API behaves and how the API links with other APIs. It explains how the API functions and the results to expect when using the API. A good example of an API reference is the OpenAPI Specification. All our APIs reference are using OpenAPI standard, where the same specification can be imported into external tools and can be use straight away to fire an API. Example of the external tool such as Postman.
API Reference Sections
Once you browse into any one of our API reference, you will see multiple sections. The sections are divided as below:
- Overview
- Endpoints
- Try It
- Schema
1. Overview
This section describe the overall definition of the APIs. It will define the secuity used, the server available for the mocking of particular API, the version of the API, and export button where the spec can be exported and consume by external tools.
2. Endpoints
This section shows the available API endpoints for each product. You can browse and navigate through each API to see the content of the APIs available, from sample request, request schema, to sample response, and response schema.
3. Try It
This feature allows participants to test out our API directly without the need to first go through the onboarding process. This gives the user a much better overview of how our API operates, what capabilities it brings, and what potential it will unlock. Participants can play around with any available API, create a mock request, and send requests to our dedicated Mock Server. A mock response will be generated and sent back to the user. To send request, simply go the any API Reference available , change the request parameters, and click Send API Request:
4. Schema
This section describes the available reusable schemas in the API Reference. This section can be ignored, as the endpoints already show each schema used for each request and response.
Exporting API Reference into Postman
Want to play around with the PayNet API without creating a full-stack application? PayNet offers a Postman Collection as a convenient tool for exploring PayNet API endpoints without writing code. The Postman Collection provides pre-formatted requests for almost all of PayNet's API endpoints that you can call from their desktop application, or a web browser. All you have to do is fill in your API keys and any arguments. Just click on export button on the API Reference to export the specification in YAML format to be used in Postman app.
