برای استفاده از این API نیاز است که فروشگاه استفاده کننده کلید مخصوص خود را از شرکت ترنج رهیافت دریافت کند
فروشگاه آزمایشی «نمونه کلید»
MzFDMUM1RkUtNjYxMy00MEVCLThBQ0EtRTI1Qjk1OUUwRTBC
آدرس API
https://RestApiMaster.toranjapp.ir/api/Values/Post
برای استفاده از متدهای API نیاز است که کلید دریافت شده در بخش Header درخواست ها به سمت سرور ارسال شود
در کلیه ریکوئست های این API پارامترها به صورت رشته در قالب XML به سرور ارسال میشود.
برای عملیات های مختلف کلیدهای مختلف در سرور تعریف میشود که در رشته ارسالی به سرور قرار داده میشود و نتیجه دریافت میشود.
دو نکته مهم در رابطه با API :
• در کلیه ورودی ها BrandName و ReportKey الزامی میباشد
• در ورودی هایی که از Mobile استفاده شده است میتوان از CustomerID نیز استفاده کرد
• برای دریافت اطلاعات که میخواهد بگیرید از TSCodeID اسفاده می شود، اگر TSCodeID صفر باشد همه اطلاعات را نشان می دهد. و اگر اخرین TSCodeID بود و ارسال کرده بود دیگه ایجاد نشده باشد خالی برمیگرداند، و آخر اگر TSCodeID عدد بود به همان نسبت اطلاعات نمایش داده می شود.
برای مثال یک نمونه کد و یک کلید ورودی نمونه استفاده شده است
کلید نمونه
<root>
<BrandName>DadehFa</BrandName>
<ReportKey>YourReportKey</ReportKey>
</root>
C# - HttpClient
var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://RestApiMaster.toranjapp.ir/api/Values/Post"); request.Headers.Add("AppId", "api_key YourSecretPassword "); var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());