GETTING STARTED
Introducing the general concepts for using the DocCrafter API, authentication methods, response codes and sample code.API REFERENCE
The DocCrafter Web API is REST-based, making it intuitive and easy to use. To prioritize your data’s security and privacy,all requests are securely transmitted using HTTPS. Kindly note, unsecured HTTP connections are not supported.
CONFIGURATION
The JSON code for configuring the DocCrafter service includes the following key components:1.URL: The URL for the DocCrafter service.
2.Headers: authorization headers required to access the service.
3.Query: Query string parameters to be included in the requests. In this case, the appName parameter is set to "DocCrafter".
4.Response: Specifies the expected responses from the service a valid response.
Base URL
https://pdf.msquare.pro
AUTHENTICATING YOUR API REQUEST
| Key | Value |
|---|---|
authorization |
api_key |
Endpoints
Request
| Method | Path |
|---|---|
GET |
/api-authentication |
Headers
authorization: api_key
Query Parameters
appName: DocCrafter
| Code | Status |
|---|---|
| 200 | Success ResponseStatus Code: 200 or 201 |
| 201 | Success Response.Status Code: 200 or 201 |
| Any except 200 or 201 | Bad input parameters. Error ResponseStatus Code: Any except 200 or 201 Type: RuntimeError Message: |