REST API

PeekHire REST API দিয়ে আপনার নিজের সফটওয়্যার নিয়োগ-সংক্রান্ত ডেটার সঙ্গে কাজ করতে পারে। এটি একটি স্ট্যান্ডার্ড HTTPS + JSON API, তাই ওয়েব রিকোয়েস্ট করতে পারে এমন যেকোনো ভাষা বা টুল এটি ব্যবহার করতে পারে।

ইন্টারঅ্যাকটিভ OpenAPI রেফারেন্সে প্রতিটি এন্ডপয়েন্ট, প্যারামিটার এবং স্কিমা দেখুন:

বেস URL এবং ভার্সনিং

API-টি ভার্সন করা হয়েছে। সব এন্ডপয়েন্ট /api/v1 প্রিফিক্সের অধীনে থাকে, যাতে ভবিষ্যতের পরিবর্তনে আপনার ইন্টিগ্রেশন নষ্ট না হয়।

অথেন্টিকেশন

বেয়ারার টোকেন হিসেবে পাঠানো API key দিয়ে প্রতিটি রিকোয়েস্ট অথেন্টিকেট করুন:

curl https://your-api-host/api/v1/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY"

ক্লায়েন্ট-সাইড কোডে বা পাবলিক রিপোজিটরিতে কখনো API key রাখবেন না।

আপনি কী অ্যাক্সেস করতে পারবেন

v1 API-তে নিয়োগের মূল অবজেক্টগুলো রয়েছে:

• ক্যাম্পেইন — আপনি যে পদে নিয়োগ করছেন, সেগুলোর তালিকা দেখুন এবং তথ্য নিন।
• আবেদন — প্রার্থীদের জমা দেওয়া আবেদনগুলোর তালিকা দেখুন এবং তথ্য নিন।
• ব্যবহারকারী — আপনার ওয়ার্কস্পেসের সদস্যদের তালিকা দেখুন এবং তথ্য নিন।

রেসপন্সগুলো JSON ফরম্যাটে আসে এবং অ্যাপে দেখা ফিল্ডগুলো অন্তর্ভুক্ত করে; যেমন, ক্যাম্পেইনের শিরোনাম ও স্ট্যাটাস অথবা আবেদনের ধাপ ও ভাষা।

পেজিনেশন এবং ফিল্টারিং

তালিকার এন্ডপয়েন্টগুলো ফলাফল পেজ আকারে ফেরত দেয়। বড় ফলাফলের সেট পেজ করে দেখতে পেজিনেশন প্যারামিটার ব্যবহার করুন, আর সমর্থিত ক্ষেত্রে ফিল্টার করুন—তাহলে শুধু আপনার প্রয়োজনীয় তথ্যই পাবেন।

ত্রুটি

API-তে স্ট্যান্ডার্ড HTTP স্ট্যাটাস কোড ব্যবহার করা হয়—সফলতার জন্য 2xx, আপনার রিকোয়েস্টে সমস্যার জন্য 4xx (যেমন, key না থাকা বা অবৈধ হওয়া), এবং সার্ভারে অপ্রত্যাশিত ত্রুটির জন্য 5xx। কী সমস্যা হয়েছে তা বর্ণনা করে এমন একটি মেসেজ ত্রুটির রেসপন্সে থাকে।

সম্পর্কিত

• API keys
• পোলিংয়ের বদলে পুশ নোটিফিকেশনের জন্য Webhooks