Communications
Allows to get and create communications.
| API | Description |
|---|---|
| GET api/communications/{id} |
Returns information about a communication. |
| GET api/communications/inbox/subject/{subject}?pageNumber={pageNumber} |
Returns communications received that matches a given subject. |
| GET api/communications/inbox/sender/{sender}/{initialDate}/{finalDate}?pageNumber={pageNumber} |
Returns communications received from a given sender and between a date interval. |
| GET api/communications/inbox/dates/{initialDate}/{finalDate}?pageNumber={pageNumber} |
Returns communications received between two given dates. |
| GET api/communications/sent/subject/{subject}?pageNumber={pageNumber} |
Returns communications sent that matches a given subject. |
| GET api/communications/sent/recipient/{recipient}/{initialDate}/{finalDate}?pageNumber={pageNumber} |
Returns communications sent addressed to a given recipient and between a date interval. |
| GET api/communications/sent/dates/{initialDate}/{finalDate}?pageNumber={pageNumber} |
Returns communications sent between two given dates. |
| GET api/communications/{talkId}/state |
Returns the state of a communication. |
| GET api/communications/userReference/{userReference}/state |
Returns the state of a communication from the authenticated user that matches a user reference. |
| GET api/communications/userReference/{userReference}/{date}/state |
Returns the state of a communication from the authenticated user that matches a user reference id and a date. |
| GET api/communications/{talkId}/info |
Returns information about a communication, including sender, recipients and documents. |
| GET api/communications/userReference/{userReference}/info |
Returns information about a communication, including sender, recipients and documents, from the authenticated user that matches a user reference id. |
| GET api/communications/userReference/{userReference}/{date}/info |
Returns information about a communication, including sender, recipients and documents, from the authenticated user that matches a user reference id and a date. |
| GET api/communications/{talkId}/activities |
Returns the list of activities registered for a communication. |
| GET api/communications/userReference/{userReference}/activities |
Returns the list of activities registered for a communication from the authenticated user that matches a user reference id. |
| POST api/communications |
Creates a communication. |
Deposits
Allows to get and set deposits.
Auth
Allows to register users.
| API | Description |
|---|---|
| POST api/auth/register |
Creates a new user account. |
Users
Provides profile and balance operations for the authenticated user.
| API | Description |
|---|---|
| GET api/users/me |
Returns the authenticated user's profile and current account balance. |
| POST api/users/me/paypal |
Creates a pending balance top-up and returns its PayPal payment URL. Taxes are added by the payment service. Balance is credited only after payment confirmation. |
Documents
Allows to get and create documents.
| API | Description |
|---|---|
| GET api/documents/{id} |
Gets information about a document. |
| POST api/documents/{id} |
Uploads a document. |
Token
Allows to authenticate an user.
| API | Description |
|---|---|
| POST api/token/wskey |
Returns the existing web service key for valid user credentials with web service access enabled. |
| POST api/token/authenticate |
Validates a set of user's credentials and returns an authentication token. |
| POST api/token/delegatedlogin |
Allows to authenticate a partner user. |
Contracts
Allows to get and create contracts.
Certificates
Allows to get certificates.
| API | Description |
|---|---|
| GET api/certificates/{code} |
Returns certificate information and PDF content by verification code. |
| GET api/certificates/communication/{talkId}/{type} |
Returns the latest certificate of the specified type for a communication. |
Sms
Allows to get and send SMS.
| API | Description |
|---|---|
| GET api/sms/{id} |
Returns information about a short message. |
| GET api/sms/sent/subject/{text}?pageNumber={pageNumber} |
Returns messages sent that matches a given text. |
| GET api/sms/sent/recipient/{recipient}/{initialDate}/{finalDate}?pageNumber={pageNumber} |
Returns messages sent addressed to a given recipient and between a date interval. |
| GET api/sms/sent/dates/{initialDate}/{finalDate}?pageNumber={pageNumber} |
Returns messages sent between two given dates. |
| POST api/sms |
Sends a SMS. |
Partners
Allows to get and set information related to partners.
| API | Description |
|---|---|
| GET api/partners/userslist |
Returns a list of users that belong to a partner. |
| GET api/partners/userdetails/{id} |
Returns details about a partner user by user identifier. |
| GET api/partners/userdetails/username/{username} |
Returns details about a partner user by username. |
| DELETE api/partners/delete/{id} |
Delete a partner user by user identifier. |
| DELETE api/partners/delete/username/{username} |
Delete a partner user by username. |
ReverseCharge
Allows to list and create reverse sending invitations.
| API | Description |
|---|---|
| POST api/reversecharge |
Adds a reverse charge sender to the allowed list. |
| DELETE api/reversecharge?email={email} |
Deletes a sender from the allowed list. |
| GET api/ReverseCharge |
Returns a list of allowed senders. |