iBox je webová služba, která poskytuje spolehlivý a bezpečný komunikační kanál pro přenos dat mezi různými informačními systémy. Služba iBox poskytuje RESTful API, které se snadno integruje a používá. Soubory odesíláte a přijímáte pomocí datových zpráv, přičemž se vyhnete problematickému ukládání souborů na FTP servery, uchovávání přihlašovacích údajů ke každému z nich, případně nutnosti starat se o jejich provoz.
Služba rovněž nabízí propracovaný systém notifikací.
iBox is a web service, that provides reliable and safe communication channel for data transfer between various ERPs. iBox service provides RESTful API, that is easy to integrate and use. Files are sent and received using data messages, while avoiding problematic saving the files to FTP servers, keeping logins of each of them or eventual need to take care of the servers.
Service also provides sophisticated notification system.
Nejprve je nutné se zaregistrovat a získat svoji schránku iBox. Každý vlastník schránky iBox si může vytvořit libovolný počet uživatelů s různou úrovní oprávnění, kteří mají ke schránce přístup. Prostřednictvím API nebo webového rozhraní se vytvoří datová zpráva, která se odešle do schránky adresáta. Odesílatel pak ve svých odeslaných zprávách vidí, zda adresát již zprávu otevřel.
Při každé události, která je svázána s datovou zprávou, je možné odeslat notifikaci. Notifikace může být HTTP volání (například vlastní webové služby) nebo odeslání e-mailu.
At first it is necessary to register and acquire your iBox. Every iBox owner is able to create vast number of users, that can access the box with different levels of competencies. Using API or web interface is created a data message, that is sent to the recipients box. The sender is then able to see (in Sent Messages Folder) whether the message was already opened by the recipient.
It is possible to send notification with ever occasion that is linked to the data message. Notification can be a HTTP call (e.g. your own web service) or an e-mail.
K plnohodnotnému využívání služby iBox potřebuje pouze webový prohlížeč pro přístup k registraci schránky, správě uživatelů a notifikací. Integrace pomocí REST API pak vyžaduje pouze možnost provádět HTTP volání z vašeho vývojového prostředí.
For the full-fledged use of the iBox service you only need a web browser to access the registration of the iBox and to administer the users and notifications. Integration using REST API only requires the ability to perform a HTTP call from your development environment.
Nejprve je nutné se přihlásit a získat přístupový token:
At first it is necessary to log in and acquire the access token:
POST https://ibox.solitea.cz/api/token
Accept: application/json
username=my.e-mail@any.com&password=secret_pwd
Odpověď
Response
"VXNlcklkPTAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCZJUD0xOTIuMTY4LjEwLjE3OCZWYWxpZFRvPTIyLjEwLjIwMTkgMTU6Mjk6MzkmSGFzaD1hM0N5dWFYNnkrV2tja0p6QjJjb2lDY3I0Ykk9"
Příklad odeslání datové zprávy do schránky 61681202:
Example of sending a data message to a box 61681202:
POST https://ibox.solitea.cz/api/data/upload
Accept: application/json
Content-Type: application/json
X-Token: VXNlcklkPTAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCZJUD0xOTIuMTY4LjEwLjE3OCZWYWxpZFRvPTIyLjEwLjIwMTkgMTU6Mjk6MzkmSGFzaD1hM0N5dWFYNnkrV2tja0p6QjJjb2lDY3I0Ykk9
{
"Recipient_OrganizationNumber":"61681202",
"Matter":"Invoice",
"ContentType":"application/octet-stream",
"FileName":"SDP-2016-00007.isdoc",
"ReferenceNumber": "SDP-2016-00007",
"Data":"PD94bWwgdmVyc2lvbj0iMS4wIj8+DQo8SW50ZXJuYWwgdmVyc2lvbj0iNS4zLjEiIHhtbG5zPSJodHRwOi8vd3d3LnZhcmlvLmN6L25hbWVzcGFjZS9pc2RvYy9pbnRlcm5hbCI+PERvY3Vt
…
xpbmU+PC9Eb2N1bWVudExpbmVzPjwvSW50ZXJuYWw+DQo="
}
Příklad načtení seznamu zpráv (počínaje 10. zprávou dvě zprávy):
Example of loading of a message list (two messages starting from 10th message):
GET https://ibox.solitea.cz/api/data/received/10/2
Accept: application/json
Content-Type: application/json
X-Token: VXNlcklkPTAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCZJUD0xOTIuMTY4LjEwLjE3OCZWYWxpZFRvPTIyLjEwLjIwMTkgMTU6Mjk6MzkmSGFzaD1hM0N5dWFYNnkrV2tja0p6QjJjb2lDY3I0Ykk9
Odpověď
Response
[
{
"RefId": "579f9c5d-1df0-469f-abc9-2e141f5f7383",
"Sender_OrganizationNumber": "27404234",
"Recipient_OrganizationNumber": "61681202",
"UploadDate": "2019-10-22T17:25:24.2214105+02:00",
"Matter": "Invoice",
"FileName": "20200822.isdocx",
"ContentType": "application/octet-stream",
"ContentLength": 212091,
"IsRead": true,
"RowVersion": "AAAAAAAAZfk=",
"UploadOrder": 10,
"ReferenceNumber": "20200822"
},
{
"RefId": "90dcc64d-4e67-472b-bc29-1099e07355f1",
"Sender_OrganizationNumber": "27404234",
"Recipient_OrganizationNumber": "61681202",
"UploadDate": "2019-10-22T17:25:24.2214105+02:00",
"Matter": "Deposit",
"FileName": "20200609.isdocx",
"ContentType": "application/octet-stream",
"ContentLength": 211841,
"IsRead": true,
"RowVersion": "AAAAAAAAZfo=",
"UploadOrder": 15,
"ReferenceNumber": "20200609"
}
]
Příklad stažení souboru ke zprávě 579f9c5d-1df0-469f-abc9-2e141f5f7383:
Example of downloading a file belonging to a message 579f9c5d-1df0-469f-abc9-2e141f5f7383:
GET https://ibox.solitea.cz/api/data/download/579f9c5d-1df0-469f-abc9-2e141f5f7383
Accept: application/json
Content-Type: application/json
X-Token: VXNlcklkPTAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCZJUD0xOTIuMTY4LjEwLjE3OCZWYWxpZFRvPTIyLjEwLjIwMTkgMTU6Mjk6MzkmSGFzaD1hM0N5dWFYNnkrV2tja0p6QjJjb2lDY3I0Ykk9
Odpověď
Response
"PD94bWwgdmVyc2lvbj0iMS4wIj8+DQo8SW50ZXJuYWwgdmVyc2lvbj0iNS4zLjEiIHhtbG5zPSJodHRwOi8vd3d3LnZhcmlvLmN6L25hbWVzcGFjZS9pc2RvYy9pbnRlcm5hbCI+PERvY3Vt
… xpbmU+PC9Eb2N1bWVudExpbmVzPjwvSW50ZXJuYWw+DQo="
Více informací naleznete s sekci API.
More information you can get in API section.