Explore API's & Guides
In the Developer Hub of Novopayment, you will find API documentation categorized by use cases. Additionally, in each section of these categories, you can access the API Reference, guides explaining various API uses, and even SDK documentation.
In this guide, we will explain in detail how to access the documentation of an API and its endpoints, as well as what you can find in the documentation of each one.
Explore API Reference
Go to the main menu and hover over "Docs." A submenu will appear, displaying the most common use cases along with a brief description and the option to access the API Reference, as shown in the following image.
Click on the API Reference for the use case that closely matches what you're looking for. Here, you will find a more detailed explanation of this use case, along with all the corresponding APIs.
*If you're unsure about your use case, don't worry. Feel free to explore; this menu will always be available for easy access to all use cases and APIs. Additionally, you can go to the "Discover" section, where you can quickly view all APIs, their descriptions, and filter them by use case.
Once you select the API reference, you will find a brief explanation of this use case. Read the overview and select the API you need on the left side.
Operations- Endpoints API Reference
Now you will find a brief explanation of the API, and you can discover all endpoints and schemas of the API by clicking on the endpoint you want to explore.
*You can also download the API reference documentation in a YAML file of all APIs in an OpenAPI 3.0 standard format by clicking on "Export."
Once you have selected an operation or endpoint, you will see a description of the operation, technical documentation, request samples in different programming languages, response examples for each code, and error code samples.
Sandbox
On the right side of the documentation, you will find a "sandbox" section, which you can use once you are registered, create an online project, and obtain an access token. You can get more details in the "Get my access token" guide.
In this sandbox, you can view and modify the request body, as well as send the API request and receive a response to better understand the documentation.
Request Sample
On the right side of the documentation, just below the "sandbox" section, you can view and copy the request sample of the endpoint. However, if you need this example in other languages, you can click on "Request sample: Shell/Curl," and you will be able to view it in languages such as JavaScript, Node.js, Python, Go, C, C#, Java, HTTP, Kotlin, PHP, R, Ruby, Swift, and more.
Response Codes & Sample
Lastly, at the end of the documentation, you will always find the response statuses, the response structure or object along with details, and you will be able to view response examples.
By default, you will see the response sample for status code 200. However, you can view the example for each error code for any response status by following these steps:
- First, select the status code you wish to view under the "Responses" section.
- Then, go to the bottom right and click on the "Response Example" checkbox. This will display all the possible responses available for that status code. By selecting the one you want, you can view the example along with its code, description, and body (if applicable).
Now that you know what you can find in our Developer Hub, you might want to consider registering and creating a project online, which is completely free. Alternatively, you can get in touch with our sales team for more information.