Contents Now Platform Custom Business Applications Previous Topic Next Topic Scripted REST APIs good practices Subscribe Log in to subscribe to topics and get notified when content changes. ... SAVE AS PDF Selected Topic Topic & Subtopics All Topics in Contents Share Scripted REST APIs good practices Follow these guidelines when designing and implementing Scripted REST APIs. Follow REST API conventionsUse REST API standards to provide a consistent and easy to use interface for clients.Use versioning to control changes to your APIUse versioning to implement new functionality and avoid breaking existing integrations.Return an informative HTTP status codeReturn a status code that informs the requestor of the success or failure of the request.Return useful error informationProvide the client with enough information in error messages to allow them to understand the problem without having to refer to your API documentation.Enforce and test access controlsEnforce existing access controls and require additional access to modify data.Build tests to verify functionalityBuild tests that verify your Scripted REST web services functionality as part of your development process. On this page Send Feedback Previous Topic Next Topic
Scripted REST APIs good practices Follow these guidelines when designing and implementing Scripted REST APIs. Follow REST API conventionsUse REST API standards to provide a consistent and easy to use interface for clients.Use versioning to control changes to your APIUse versioning to implement new functionality and avoid breaking existing integrations.Return an informative HTTP status codeReturn a status code that informs the requestor of the success or failure of the request.Return useful error informationProvide the client with enough information in error messages to allow them to understand the problem without having to refer to your API documentation.Enforce and test access controlsEnforce existing access controls and require additional access to modify data.Build tests to verify functionalityBuild tests that verify your Scripted REST web services functionality as part of your development process.
Scripted REST APIs good practices Follow these guidelines when designing and implementing Scripted REST APIs. Follow REST API conventionsUse REST API standards to provide a consistent and easy to use interface for clients.Use versioning to control changes to your APIUse versioning to implement new functionality and avoid breaking existing integrations.Return an informative HTTP status codeReturn a status code that informs the requestor of the success or failure of the request.Return useful error informationProvide the client with enough information in error messages to allow them to understand the problem without having to refer to your API documentation.Enforce and test access controlsEnforce existing access controls and require additional access to modify data.Build tests to verify functionalityBuild tests that verify your Scripted REST web services functionality as part of your development process.
