General information

Main features

• Invoice management: create, cancel, check status

• Payment management: list of payments, binding payment to invoice

• Statistics: get aggregated data by projects, by periods, by wallets, etc.

API key

• You can get API key in Integrations

• Key scope: access to all data in your personal cabinet

• In the future we will improve API functionality and implement the following settings: key scope, replacement/deletion/creation of multiple keys in progress

Limitations

• Number of requests: no more than 1 request per second

Authorization of requests

To authorize each request to the API, your API key must be passed in the Authorization header.

An example of using the Authorization header in an API request:

curl -X POST https://api.bitsby.app/invoices/list \\
  -H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay"

Server response

The API server response always comes in JSON format. Focus on the result parameter to determine if the request result is successful.

An example of the server response in case of a positive request result:

{
    "result": "success",
    "data": .....
}

An example of server response in case of an error:

{
    "result": "error",
    "data": "Requests too frequent"
}