DownloadsDocumentationAPI ReferenceChangelogOpen A TicketContact

Best Practices

Suggest Edits

Best Practices in API

  • Try the API request in Postman or API explorer before using in code
  • To update or delete a document in http or file collection use docadd request
  • For updating a document and customize the content/meta tags in custom, HTTP or file collection use add API request in REST API
  • Form authentication for HTTP Collection will work with docadd API request only
  • For file collection add API use forward slash only
  • For REST and HTTP API requests, refer the error code for the cause of the issue
  • Ensure to give working URL in the requests
  • It is mandatory to give meta tag in add JSON API request
  • API key is mandatory in all API requests

Updated almost 4 years ago