ARCHYZEN API / v1

თქვენი პლატფორმა.თქვენი ინტეგრაციები.

დააკავშირეთ ლიდები, გაყიდვები, კლიენტები, პროექტები და უძრავი ქონება თქვენს სამუშაო ინსტრუმენტებთან. მართეთ წვდომა და შეამოწმეთ მოთხოვნები ერთ სივრცეში.

დოკუმენტაციის ნახვა ინსტრუმენტების გაცნობა

REST APIJSONUTF-8v1

თქვენი აპლიკაცია

archyzen / apiv1

POST/neoplatform/api/v1/?resource=leads

{
  "full_name": "Example Lead",
  "email": "lead@example.com",
  "phone": "+995555000000"
}

201 Created{ "success": true }

საილუსტრაციო მაგალითი

ArchyZen-ის პლატფორმა

01 / API

5 სერვისი

განსაზღვრული წვდომის გასაღებები

ტესტირება ბრაუზერში

02 / დეველოპერის სამუშაო სივრცე

პირველი გასაღებიდან მომდევნო მოთხოვნამდე.

კომპანიის პანელში გვერდი „დეველოპერებისთვის“ აერთიანებს წვდომის მართვას, API დოკუმენტაციას, ჩანაწერების ID-ებსა და ტესტირებას.

გასაღებები მკაფიო უფლებებით

შექმენით რამდენიმე გასაღები თითოეული სერვისისთვის. აირჩიეთ წაკითხვის, დამატების, განახლებისა და წაშლის უფლებები და სურვილისამებრ მიუთითეთ ვადა.

კომპანია / სერვისი / უფლებები

წვდომის მართვა თქვენს ხელშია

დაარქვით გასაღებს სახელი, შეცვალეთ ან გააუქმეთ. გაუქმებული გასაღებები არქივში გადადის, სადაც მათი ნახვა წვდომის აღდგენის გარეშე შეგიძლიათ.

დოკუმენტაცია მაგალითებით

გაეცანით ხუთივე სერვისის ენდპოინტებს, ველებსა და cURL მაგალითებს. გადაიტანეთ მაგალითი პირდაპირ ჩაშენებულ ტესტირების სივრცეში.

იპოვეთ საჭირო ID-ები

მოძებნეთ ჩანაწერები და ცნობარის მნიშვნელობები, შემდეგ დააკოპირეთ მოთხოვნისთვის საჭირო პროექტის, სტატუსის, წყაროს, თანამშრომლის ან სხვა ჩანაწერის ID.

ტესტირება გვერდიდან გაუსვლელად

ჩატვირთეთ cURL მაგალითი, მიუთითეთ გასაღები და გაუშვით ბრაუზერში. ნახეთ პასუხის სტატუსი და JSON დამატებითი პროგრამის დაყენების გარეშე.

ინსტრუმენტების გაცნობა

03 / API ცნობარი

პრაქტიკული გზამკვლევი თქვენი ინტეგრაციისთვის.

აირჩიეთ რესურსი და მოქმედება, რათა გაეცნოთ მოთხოვნის ფორმატს, ხელმისაწვდომ ველებსა და პასუხის მაგალითს.

დაადასტურეთ წვდომა თითოეულ მოთხოვნაში

გააგზავნეთ API გასაღები Authorization: Bearer სათაურით. თითოეული გასაღები ეკუთვნის ერთ კომპანიასა და ერთ სერვისს, თქვენ მიერ არჩეული უფლებებით.

Authorization: Bearer YOUR_API_KEY

დაკავშირებული პროექტები, ქონება, სტატუსები, კლიენტები, ლიდები და თანამშრომლები თქვენს კომპანიას უნდა ეკუთვნოდეს. მოთხოვნის გაგზავნამდე მათი ID-ები პანელში მოძებნეთ.

API-ზე წვდომა დამოკიდებულია კომპანიის აქტიურ გამოწერაზე, ჩართულ სერვისებსა და ჩანაწერების ლიმიტებზე.

API გასაღებები შეინახეთ თქვენს სერვერზე; არ განათავსოთ ისინი საჯარო JavaScript კოდში ან საჯარო რეპოზიტორიაში.

ენდპოინტიhttps://archyzen.com/neoplatform/api/v1/

ლიდები

?resource=leads

ლიდების გასაღების შექმნისას აირჩიეთ წყარო. გასაღებს წვდომა ექნება მხოლოდ ამ წყაროს ლიდებზე; წყაროს შეცვლა API-ით შეუძლებელია.

მოთხოვნის მაგალითი

შეცვალეთ მაგალითის ID-ები და YOUR_API_KEY თქვენი მნიშვნელობებით. ამ საჯარო მაგალითებიდან მოთხოვნები არ იგზავნება.

ჩანაწერის ველები

სავალდებულო ველები აუცილებელია ჩანაწერის შექმნისას. PATCH და PUT მოთხოვნებში გააგზავნეთ მხოლოდ ის ველები, რომელთა შეცვლაც გსურთ.

არასავალდებულო ველები

მხოლოდ წასაკითხი ველები

მოძებნეთ საჭირო ჩანაწერები

GET-ით მიიღეთ ჩანაწერების სია ან კონკრეტული ჩანაწერი ID-ით. სიისთვის ხელმისაწვდომია გვერდებად დაყოფა და ძიება. PATCH და PUT მხოლოდ გადაცემულ ველებს აახლებს; გამოტოვებული ველები უცვლელი რჩება.

limitoffsetq

ცნობარის მნიშვნელობები მოთხოვნებისთვის

GET lookups აბრუნებს არჩეული სერვისისა და გასაღების წვდომის ფარგლებში ხელმისაწვდომ ID-ებსა და ცნობარის მნიშვნელობებს. ჩანაწერების ID-ები კომპანიის პანელშიც შეგიძლიათ მოძებნოთ.

ცნობარები ნაგულისხმევად თითო ჯგუფში მაქსიმუმ 100 ჩანაწერს აბრუნებს. შეამოწმეთ meta.has_more და მომდევნო გვერდისთვის გამოიყენეთ offset.

JSON მოთხოვნაშიც და პასუხშიც

გააგზავნეთ JSON UTF-8 კოდირებით. პასუხი შეიცავს წარმატების მაჩვენებელსა და მონაცემებს, ან სტრუქტურირებულ შეცდომას მოთხოვნის ID-ით, პრობლემის მოსაძიებლად.

HTTP სტატუსის კოდები

400invalid_json / invalid_id / id_required / unexpected_id / invalid_lookup401missing_api_key / invalid_api_key / source_unavailable403

permission_denied / scope_mismatch / service_scope_mismatch / source_scope_mismatch / invalid_scope / account_unavailable / subscription_required / feature_unavailable / source_unavailable

404resource_not_found / unknown_resource / not_found405method_not_allowed409record_in_use / record_conflict / subscription_limit_reached / status_required413body_too_large415unsupported_media_type422validation_failed / invalid_reference / unknown_field / unsupported_field429rate_limit_exceeded500internal_error503setup_required / schema_unavailable / service_unavailable / relation_recovery_required

{
  "success": false,
  "error": { "code": "invalid_reference", "message": "..." },
  "request_id": "EXAMPLE_REQUEST_ID"
}

მოთხოვნების ლიმიტები

თითოეულ გასაღებს წუთში 120 მოთხოვნა შეუძლია. სია ნაგულისხმევად 25 ჩანაწერს აბრუნებს; დასაშვები ლიმიტია 1–100. JSON მოთხოვნის მოცულობა შეიძლება იყოს მაქსიმუმ 1 MB.

შეამოწმეთ X-RateLimit-Limit, X-RateLimit-Remaining და X-RateLimit-Reset. HTTP 429 პასუხისას დაელოდეთ Retry-After-ით მითითებულ დროს. თუ ჩაწერის მოთხოვნას დრო ამოეწურა, ხელახლა ცდამდე შეამოწმეთ ჩანაწერი.

120 / minlimit ≤ 1001 MB

აკონტროლეთ აქტიური წვდომა

გასაღების შეცვლა ძველ გასაღებს მაშინვე აუქმებს. ვადაგასული და გაუქმებული გასაღებები აღარ მუშაობს. გაუქმებული გასაღებები სანახავად რჩება მხოლოდ წასაკითხ არქივში.

expires_atrevoked_at

04 / მოთხოვნის წინასწარი ნახვა

ნახეთ, როგორ აიგება მოთხოვნა.

აირჩიეთ რესურსი და ნახეთ პასუხის მაგალითი. ეს საჯარო დემო სიმულაციაა: ის თქვენს ანგარიშს არ უკავშირდება და API მოთხოვნას არ აგზავნის.

ArchyZen / ტესტირებასაილუსტრაციო მაგალითი

საილუსტრაციო მაგალითი

სიმულირებული პასუხი

ინტეგრაციის დაწყებამდე

სად შევქმნა და დავაკოპირო გასაღები?

შედით კომპანიის პანელში და გახსენით „დეველოპერებისთვის“. სრული გასაღები ერთხელ ჩანს შექმნის ან შეცვლისას და მისი კოპირება იმავე გვერდზე ყოფნისას შეგიძლიათ. გვერდიდან გასვლამდე უსაფრთხოდ შეინახეთ.

შემიძლია ერთ წყაროს რამდენიმე გასაღები შევუქმნა?

დიახ. წყაროს ან სერვისისთვის შექმენით იმდენი გასაღები, რამდენიც გჭირდებათ — თითოეულს თავისი სახელი, უფლებები და სურვილისამებრ ვადა ექნება. ლიდების გასაღები ყოველთვის არჩეულ წყაროს უკავშირდება.

შეიძლება API-ით ფოტოებისა და ფაილების ატვირთვა?

მედიის ველები მხოლოდ წასაკითხ გზებს ან URL-ებს აბრუნებს. ეს JSON API multipart ფაილების ატვირთვას არ უზრუნველყოფს. ფაილები პლატფორმაში დაამატეთ და მართეთ.

რა ხდება, თუ ჩანაწერი სხვა მონაცემებს უკავშირდება?

წაშლა, რომელიც აუცილებელ კავშირს დაარღვევდა, HTTP 409 პასუხს აბრუნებს. ხელახლა ცდამდე შეამოწმეთ დაკავშირებული მონაცემები; API დაკავშირებულ ბიზნესჩანაწერებს ავტომატურად არ შლის.

გააერთიანეთ თქვენი ინსტრუმენტები სამუშაო პროცესში.

მოითხოვეთ ArchyZen-ზე წვდომა, შექმენით გასაღებები და ააწყვეთ ინტეგრაცია თქვენი კომპანიის მონაცემებისთვის.

წვდომის მოთხოვნა კომპანიებისთვის