REST API

In 2019 Q3 we just introduced our brand new REST API, to give an opportunity to integrate BitNinja into any application.

What is API?

Application Programming Interface (API) is an interface or communication protocol between a client and a server intended to simplify the building of client-side software. It has been described as a “contract” between the client and the server, such that if the client makes a request in a specific format, it will always get a response in a specific format or initiate a defined action.

What is REST?

REST is acronym for REpresentational State Transfer. It is architectural style for distributed hypermedia systems and was first presented by Roy Fielding in 2000 in his famous dissertation.

API V2

We already have an API, but it’s used by internal purposes. We wanted to give the best experience for our users, so we have created a brand new API for every BitNinja user!

You can find the API at https://api.bitninja.io/v2

We would like to implement as many features as possible as soon as possible. To discover the capabilities of the API, we created a Swagger documentation page. You can find the Swagger documentation here: https://api.bitninja.io/v2/swagger/

_images/apiv2-swagger.png

To use the endpoints you have to login first. You can use your BitNinja credentials or simply your license key.

_images/apiv2-login-with-licensekey.png

Note

You can use your credentials at https://api.bitninja.io/v2/authentication/login/credentials endpoint.

After the successful login, the API gives you an access token. To use it click on Authorize at the top-right corner, then paste your access token in the following form:

bearer yourAccessToken
_images/apiv2-use-access-token.png