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

Table 1. HTTP verbs Wenenu’s API
HTTP Verb Meaning


Fetch a resource, returned in the request body


Creates a new resource


Updates an existing resource


Deletes an existing resource


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.

Table 2. HTTP Codes used by Wenenu’s API
HTTP Code Meaning


OK, request was successful


Resource created


Accepted and no content returned


Bad request, check your parameters


Missing API Key / Credentials


Unauthorised (Probably a key with the wrong permissions)


Resource not found


Server errors, Wenenu encountered an internal problem

Refer to API Authentication for how to get your API keys and begin hitting our API