API overview [???]
Wenenu’s REST APIs
Wenenu’s APIs (Application Programming Interfaces) is an HTTPS REST API, authenticated by a bearer token Our API has predictable resource-oriented URLs, standard HTTP semantic return status codes , process and returns JSON-encoded responses, authentication, and verbs.
Documentation and samples
All our API endpoints are documented with curl examples, we trust you are familiar with that command line tool, and its format has become kind of standard. However, you can easily generate Python, Go, PHP, Java, Rust, etc with copying and pasting the curl command into most HTTP clients (Insomnia, Postman or even use Convert curl syntax to Python, Ansible URI, MATLAB, Node.js, R, PHP, Strest, Go, Dart, Java, JSON, Elixir, Rust )
Operation semantics
In the spirit of not reinventing the wheel, HTTP Verbs follow convention, a quick recap can be seen below
| HTTP Verb | Meaning |
|---|---|
GET |
Fetch a resource, returned in the request body |
POST |
Creates a new resource |
PUT |
Updates an existing resource |
DELETE |
Deletes an existing resource |
Errors
HTTP Response codes used by Wenenu are in line what the standard practices, 2xx codes means success, 4xx have to do with incorrect information sent (including bad API keys, a valid key with insufficient permissions, missing parameters, parameters not passing validation, etc). 5xx would be Wenenu API failing to carry out your request due to internal errors
Most errors will include an explaining in the response body of what has gone wrong.
| HTTP Code | Meaning |
|---|---|
200 |
OK, request was successful |
201 |
Resource created |
202 |
Accepted and no content returned |
400 |
Bad request, check your parameters |
401 |
Missing API Key / Credentials |
403 |
Unauthorised (Probably a key with the wrong permissions) |
404 |
Resource not found |
50x |
Server errors, Wenenu encountered an internal problem |
Refer to API Authentication for how to get your API keys and begin hitting our API
