در این مقاله در مورد مقدمه API پارسااسپیس 1 توضیح خواهیم داد.
درباره API پارسااسپیس
پارسا اسپیس با داشتن REST API امکان ارتباط برنامه های مختلف را فراهم کرده است.در این سرویس شما می توانید به آسانی و امنیت بالا در هر نقطه ای از وب و در هر زمانی اطلاعات خود را ذخیره و بازیابی نمائید(API پارسااسپیس 1). هدف این سرویس، فراهم کردن امکانات آپلود، کپی، انتقال و غیره برای توسعه دهندگان است. در این راهنما مفاهیم اصلی API Parsaspace و نحوه کار با آن توضیح داده شده است.
آدرس های وب سرویس:
آدرس های وب سرویس پارسا اسپیس پارامترهایی از نوع Get , Post دریافت و پاسخ هایی از نوع json بر می گردانند.
آدرس های وب سرویس :
اعتبارسنجی کاربر:
پارسا اسپیس برای اعتبارسنجی درخواست های API خود از توکن استفاده می کند. جهت استفاده از سرویس های پارسااسپیس باید مقدار TOKEN که از پنل کاربری خود دریافت می نمائید، در هر درخواست در قسمت Header به صورت Bearer TOKEN ارسال
نمائید.
اعتبارسنجی کاربر :
این روش رایج ترین روش اعتبارسنجی می باشد. در این روش هر کاربر با استفاده از TOKEN ایجاد شده منحصر بفرد در پنل کاربری خود می تواند در سرویس پارسااسپیس اعتبارسنجی شود و از این سرویس استفاده نماید.
TOKEN : Bearer
خطای 401 :
خطای 401 یا “Authorization has been denied for this request.” این خطا زمانی اتفاق می افتد که TOKEN نامعتبر باشد, ممکن است TOKEN تغییر کرده باشد . ممکن است کاربر TOKEN را غیرفعال یا رمز دسترسی به آن را تغییر داده باشد.
درخواست ها:
تمامی درخواست ها باید شامل Authorization در قسمت Header و Domain در قسمت Body باشند.
پارامتر های ضروری :
پاسخ ها
ساختار :
تمامی پاسخ ها در قالب JSON می باشند. اطلاعات در خواستی در تگ RESULT گنجانده می شود. اگر درخواست شما پاسخی داشته باشد RESULT با SUCCESS مقدار دهی می شود. و در صورتی خطایی اتفاق بیافتد پاسخ به این صورت که RESULT با ERROR و MESSAGE با خطای اتفاق افتاده مقدار دهی می شود.
پاسخ موفق : {“result”: “success”}
پاسخ با خطا : {“result”:”error”,”message”:”access denied”}
مدیریت خطا
خطاها به شکل کد خطای استاندارد HTTP باز می گردند. اطلاعات اضافی از خطا در قالب JSON در قسمت Body درخواست بازگردانده می شود.
کد خطاهای استاندار (Status Code):v:
لیست فایل ها
لیست تمامی فایل ها و پوشه های مسیر مورد نظر کاربر را بر می گرداند.
Method:Post
اعتبارسنجی :اعتبارسنجی کاربر
پارامترهای ارسالی :
نمونه پاسخ دریافتی:
{“result”:”success”,”list”:[{“Name”:”a.txt”,”IsFolder”:false,”Size”:8,”LastModified”:”2016-11-07 09:49:24″},{“Name”:”b.txt”,”IsFolder”:false,”Size”:3,”LastModified”:”2016-11-07 09:49:24″}]}
نمونه کد زبان های برنامه نویسی:
net.
var client = new RestClient(“http://api.parsaspace.com/v1/files/list”);
var request = new RestRequest(Method.POST);
request.AddHeader(“authorization”, “Bearer yourtoken”);
request.AddHeader(“content-type”, “application/x-www-form-urlencoded”);
request.AddParameter(“domain”, “yourdomain”);
request.AddParameter(“path”, “/”);
IRestResponse response = client.Execute(request);
php
$curl = curl_init();
curl_setopt_array($curl,
array(
CURLOPT_URL => “http://api.parsaspace.com/v1/files/list”,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST =>”POST”,
CURLOPT_RETURNTRANSFER=>true,
CURLOPT_POSTFIELDS =>”path=Your-path&domain=Your-Domain&type=json”,
CURLOPT_HTTPHEADER => array(
“authorization: Your-Token”,
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err){
echo “cURL Error #:” $err;
}
else {
echo $response;
}
java
HttpResponse response = Unirest.post(“http://api.parsaspace.com/v1/files/list”)
.header(“authorization”, “Your-token”)
.body(“path=Your-Path &domain=Your-Doamin&type=json”)
.asString();
python
import requests
url = “http://api.parsaspace.com/v1/files/list”
payload = “path=Your-Path &domain=Your-Domain &type=json”
headers = {
‘authorization’: “Your-Token”,
}
response = requests.request(“POST”, url, data=payload, headers=headers)
print(response.text)
node.js
var request = require(“request”);
var options = { method: ‘POST’,
url:’http://api.parsaspace.com/v1/files/list’,
headers:
{
authorization: ” },
form: { path: ‘/’, domain: ‘yourdomain’, type: ‘json’ } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
در این مقاله در مورد معرفی API پارسااسپیس 1 توضیح دادیم در مقاله بعد در مورد API پارسااسپیس 2 توضیح میدهیم