API message formats
Bud’s platform is made available through Application Programming Interface (API) endpoints, all of which adhere to RESTful principles where possible. Standard HTTP verbs and status codes are used for requests and response statuses. Request and response payloads are JSON encoded data formatted. Communication with the Bud Platform is handled over HTTPS protocol only.
Data Type | Standard |
---|---|
Strings encoding | UTF-8 |
Datetime | ISO 8601 |
Currency codes | ISO 4217 |
HTTP Verbs
Verb | Usage Context |
---|---|
GET | Used to retrieve the resource representation or metadata |
POST | Used to create a new resource on the server |
PUT | Used to update the resource state |
PATCH | Used to partially update a resource |
DELETE | Used to delete the resource |
HTTP Response Codes
Code Class | Description |
---|---|
1XX | Informational - provisional response from the server |
2XX | Success - the request has been processed successfully by the server |
4XX | Client Error - the request has not been processed due to client-side issue with the request |
5XX | Server Error - the request has not been processed due to server-side issue |
If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.
Updated 9 months ago