Difference between revisions of "API Reference"
Line 65: | Line 65: | ||
|- | |- | ||
| getInboxMessageById || - || - | | getInboxMessageById || - || - | ||
+ | |- | ||
+ | | getSentMessageByAckData || - || - | ||
+ | |- | ||
+ | | getAllSentMessages || - || - | ||
+ | |- | ||
+ | | getSentMessageById || - || - | ||
|- | |- | ||
| trashMessage || <msgid> || returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. msgid is encoded in hex just like in the getAllInboxMessages function. | | trashMessage || <msgid> || returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. msgid is encoded in hex just like in the getAllInboxMessages function. |
Revision as of 05:11, 2 July 2013
Enable the API
To enable the API, the folowing lines have to be inserted into the keys.dat file:
apienabled = true apiport = 8442 apiinterface = 127.0.0.1 apiusername = bradley apipassword = yourSuperWonderfulPassword98a8#5223345
Additionally, the user may optionally include an additional entry which will specify a program which Bitmessage will run when certain events occur.
apinotifypath = c:\\example\\example.exe
One of these arguments will be passed to your program: startingUp, newMessage, newBroadcast. programmers should take care, that the application does not crashes when given an unknown command line argument as this list may be expanded.
Remote Access
To access the Bitmessage API from a remote location, the apiinterface value has to be changed from 127.0.0.1 to 0.0.0.0. In case multiple Network interfaces are available and only one has to be used, its IP address can be specified instead too.
List of Operations
Required arguments are denoted inside < and > Optional arguments are inside [ and ].
Command | Parameters | Description |
---|---|---|
helloWorld | <firstWord> <secondWord> | returns 'firstWord-secondWord'. Used as a simple test of the API. |
add | <integer> <integer> | returns the sum of the integers. Used as a simple test of the API. |
statusBar | <message> | Displays the message in the status bar on the GUI |
listAddresses | Lists all addresses shown on the Your Identities tab. Returns a list of objects with these properties:
| |
createRandomAddress | <label> [eighteenByteRipe] [totalDifficulty] [smallMessageDifficulty] | Creates one address using the random number generator. label should be base64 encoded. eighteenByteRipe is a boolean telling Bitmessage whether to generate an address with an 18 byte RIPE hash(as opposed to a 19 byte hash). This is the same setting as the "Do extra work to make the address 1 or 2 characters shorter" in the user interface. Using False is recommended if you are running some sort of website and will be generating a lot of addresses. Note that even if you don't ask for it, there is still a 1 in 256 chance that you will get an address with an 18 byte RIPE hash so if you actually need an address with a 19 byte RIPE hash for some reason, you will need to check for it. eighteenByteRipe defaults to False. totalDifficulty and smallMessageDifficulty default to 1.
Returns the address. Warning: At present, Bitmessage gets confused if you use both the API and the UI to make an address at the same time. |
createDeterministicAddresses | <passphrase> [numberOfAddresses] [addressVersionNumber] [streamNumber] [eighteenByteRipe] [totalDifficulty] [smallMessageDifficulty] | Similar to createRandomAddress except that you may generate many addresses in one go. passphrase should be base64 encoded. numberOfAddresses defaults to 1. addressVersionNumber and streamNumber may be set to 0 which will tell Bitmessage to use the most up-to-date addressVersionNumber and the most available streamNumber. Using zero for each of these fields is recommended. eighteenByteRipe defaults to False. totalDifficulty and smallMessageDifficulty default to 1.
Returns a list of new addresses. This list will be empty if the addresses already existed. Warning: At present, Bitmessage gets confused if you use both the API and the UI to make addresses at the same time. |
getDeterministicAddress | <passphrase> <addressVersionNumber> <streamNumber> | Similar to createDeterministicAddresses except that the one address that is returned will not be added to the Bitmessage user interface or the keys.dat file. passphrase should be base64 encoded. addressVersionNumber should be set to 3 as this is the only one currently supported. streamNumber must be set to 1 as this is the only one currently supported.
Returns a single address. Warning: At present, Bitmessage gets confused if you use both this API command and the UI to make addresses at the same time. |
getAllInboxMessages |
Does not include trashed messages. Returns a list of objects with these properties:
The msgid is the same as the hash of the message (analogous to the TXID in Bitcoin) thus it is shown in hex as that is the de facto standard. The base64 encoding Bitmessage uses includes line breaks including one on the end of the string. | |
getInboxMessageById | - | - |
getSentMessageByAckData | - | - |
getAllSentMessages | - | - |
getSentMessageById | - | - |
trashMessage | <msgid> | returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. msgid is encoded in hex just like in the getAllInboxMessages function. |
sendMessage | <toAddress> <fromAddress> <subject> <message> [encodingType] | returns ackdata encoded in hex. subject and message must be encoded in base64 which may optionally include line breaks. If used, the encodingType must be set to 2; this is included for forwards compatibility. |
sendBroadcast | <fromAddress> <subject> <message> [encodingType] | returns ackData encoded in hex. subject and message must be encoded in base64. If used, the encodingType must be set to 2; this is included for forwards compatibility. |
getStatus | <ackData> | returns one of these strings: |
addSubscription | <address> [label] | Subscribe to an address. label must be base64-encoded. |
deleteSubscription | <address> | Unsubscribe from an address. The program does not check to see whether you were subscribed in the first place. |
Error values
Here are the various error numbers and descriptions you might see.
Error Number | Message |
---|---|
0000 | API Error 0000: I need parameters! |
0001 | API Error 0001: The specified passphrase is blank. |
0002 | API Error 0002: The address version number currently must be 3 (or 0 which means auto-select). |
0003 | API Error 0003: The stream number must be 1 (or 0 which means auto-select). Others aren't supported. |
0004 | API Error 0004: Why would you ask me to generate 0 addresses for you? |
0005 | API Error 0005: You have (accidentally?) specified too many addresses to make. Maximum 999. This check only exists to prevent mischief; if you really want to create more addresses than this, contact the Bitmessage developers and we can modify the check or you can do it yourself by searching the source code for this message. |
0006 | API Error 0006: The encoding type must be 2 because that is the only one this program currently supports. |
0007 | API Error 0007: Could not decode address |
0008 | API Error 0008: Checksum failed for address |
0009 | API Error 0009: Invalid characters in address |
0010 | API Error 0010: Address version number too high (or zero) in address |
0011 | API Error 0011: The address version number currently must be 2 or 3. Others aren't supported. |
0012 | API Error 0012: The stream number must be 1. Others aren't supported. |
0013 | API Error 0013: Could not find your fromAddress in the keys.dat file. |
0014 | API Error 0014: Your fromAddress is disabled. Cannot send. |
0015 | API Error 0015: The length of ackData should be 32 bytes (encoded in hex thus 64 characters). |
0016 | API Error 0016: You are already subscribed to that address. |
0017 | API Error 0017: Label is not valid UTF-8 data. |
0018 | API Error 0018: Chan name does not match address. |