Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required.
|GET||For retrieval of information from your Offective administration, you should use the GET method. The information you request will be returned to you as a JSON object. Any request using the GET method is read-only and will not affect any of the objects you are querying.|
|DELETE||To delete data from your administration and remove it entirely from the Offective database, use the DELETE method. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. The final state will be the same regardless of its existence.|
|PUT||To update existing information, the PUT method is available. You cannot create new data using the PUT method.|
|POST||To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.|