Overview
About API
Nilvera APIs are designed as RESTful APIs. API requests and responses are developed in accordance with HTTP standards. Detailed information about Common Objects is provided on the following pages of the documentation. OAS 3.x standards are used for API request and response types. You can integrate your own applications very quickly and smoothly with the descriptive files of the relevant APIs. Within the API documentation, all endpoints are explained in detail, including request and response types. By using the APIs, you can integrate our e-Invoice, e-Archive Invoice, e-Dispatch Note, e-Invoice for Freelancers, e-Producer Receipt, e-Receipt services with the ERP/Accounting systems and other applications you have developed.
About Test and Live Environment
The APIs are divided into Live and Test environments. The keys generated in the Test environment will be separate from the keys and company information in the Live environment. Once the integration is completed in the Test environment and live accounts are opened, there will be no issues if the endpoint is set to the live environment.
Authentication and Authorization
All our APIs use OAuth 2.0 as the authorization mechanism. Despite different applications for service APIs, you can use the APIs through a central authorization authority. The token type used in APIs is not JWT but Reference. You should generate an API Key via the Portal application to use the APIs with the username and password you previously acquired. The generated API Key will have the permissions (scopes) you specify and will only be able to perform the authorized operations. It will also become invalid when the specified period expires.
API keys are in the form of Persisted Access Tokens. Once you generate a key, you can use this key continuously and terminate its access instantly via the Portal.
Example: 9EE05B6564525810C86A32646DB46A26E20F4BCE32C0B13AB22AA78E70DC4F69
Note: Sending the API key as Authorization:Bearer {API_KEY} in the Header field of your service calls will be enough for the API to recognize and authorize you.
Last updated
