Changes for page 1. Introduction

Last modified by Giorgi Mdivnishvili on 2024/02/26 15:43

From version 2.1
edited by Giorgi Mdivnishvili
on 2024/02/26 14:57
Change comment: There is no comment for this version
To version 4.1
edited by Giorgi Mdivnishvili
on 2024/02/26 15:43
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Introduction
1 +1. Introduction
Content
... ... @@ -2,3 +2,56 @@
2 2  
3 3  
4 4  Rustar API uses rest services for data exchange. The services on Rustar side are written in .NET and can use Rest endpoints. Although the services are written in .NET, the services can be integrated with any systems that support Rest, including but not limited to JAVA, PHP, Python and others.
5 +
6 +
7 +URL for accessing Rest services is **https:~/~/restapi.rustaronline.com/v1.01/api/**
8 +
9 +In order to use the services, agent must receive following credentials:
10 +
11 +**agentid** – Unique username that is bound to agents account in Rustar
12 +
13 +**agentpassword – **Password for the agentid
14 +
15 +
16 +To obtain **agentid **and**a gentpassword **for accessing the services the company must send request to [email protected]
17 +
18 +
19 +For development purposes the following credentials can be used:
20 +
21 +**URL**- https:~/~/restapi.rustaronline.com/v1.01/api/
22 +
23 +**agentid** – test.test
24 +
25 +**agentpassword – **TestP@ssw0rd
26 +
27 +
28 +All methods return following JSON object
29 +
30 +{{code language="json"}}
31 +{
32 + "Code": "00",
33 + "Message": "",
34 + "Timestamp": "2016-06-27T17:42:25.6292336+04:00",
35 + "Version": “1.01”,
36 +"ResponseID":"b512a117-6745-493d-9fa4-828d79c0df1d"
37 + "Data": [
38 + /**/
39 + ]
40 +}
41 +
42 +{{/code}}
43 +
44 +
45 +Where
46 +
47 +**Code**: CHAR(2) parameter. “00” in case of success. In case of failure other than “00” is returned
48 +
49 +**Message**: string parameter. “” in case of success. In case of failure the description of the problem/error
50 +
51 +**Timestamp**: datetime parameter. The date and time of the returned message
52 +
53 +**Version**: string parameter. Version of the API
54 +
55 +**ResponseID**: GUID parameter. Unique GUID of the response message
56 +
57 +**Data**: The array of the objects, depending on the method that was called