The Bidtheatre API is fully RESTful. Users can access the resources provided by the API by using standard HTTP methods. Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI.
For retrieval of information about any object, you should use the GET method.
The information you request will be returned to you as a JSON object.
Relationships are displayed as "object links" or "link objects", allowing you to retrieve more information about that relationship. You can read more details about this under the relationships section listed below.
Any request using the GET method is read-only and will not affect any of the objects you are querying.
To remove a object, the DELETE method should be used.
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.
This means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.
To update the information about a resource in your network, the PUT method is available.
Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.
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.
Only the fields given in the request are updated.
PATCH is generally not implemented but in some cases where new object fields have been added PATCH is supported to facilitate updates of those fields without introducing breaking changes.
To ensure good performance, all accounts are limited to 100 reads per minute and 60 writes per minute. This limit is enforced programmatically by the API on a network level. That means if there are several API users for a single network, they will share the throttling limit.
Updated over 3 years ago