Base URL
https://beecastly.com/apiਸਾਰੇ API ਅੰਤਮ ਬਿੰਦੂ ਇਸ ਅਧਾਰ URL ਨਾਲ ਸੰਬੰਧਿਤ ਹਨ।
ਤੇਜ਼ ਸ਼ੁਰੂਆਤ
curl -X GET https://beecastly.com/api/contacts \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "x-tenant-id: YOUR_TENANT_ID" \ -H "Content-Type: application/json"
ਪ੍ਰਮਾਣੀਕਰਨ
ਸਾਰੀਆਂ ਬੇਨਤੀਆਂ ਨੂੰ ਇਹਨਾਂ ਵਿੱਚੋਂ ਇੱਕ ਰਾਹੀਂ ਪ੍ਰਮਾਣਿਕਤਾ ਦੀ ਲੋੜ ਹੁੰਦੀ ਹੈ:
- API ਕੁੰਜੀ — Authorization: Bearer YOUR_API_KEY ਹੈਡਰ ਵਿੱਚ ਭੇਜੋ
- JWT ਟੋਕਨ — POST /auth/login ਤੋਂ ਮਿਲਦਾ ਹੈ
ਇਸ ਤੋਂ ਇਲਾਵਾ, ਆਪਣੀ ਟੈਨੈਂਟ ID ਸ਼ਾਮਲ ਕਰੋ: x-tenant-id: YOUR_TENANT_ID
API ਅੰਤ ਬਿੰਦੂ
ਜਵਾਬ ਫਾਰਮੈਟ
ਸਾਰੇ ਜਵਾਬ ਇਕਸਾਰ JSON ਫਾਰਮੈਟ ਦੀ ਪਾਲਣਾ ਕਰਦੇ ਹਨ:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}ਦਰ ਸੀਮਾਵਾਂ
ਮੁਫ਼ਤ ਟੀਅਰ: 100 ਬੇਨਤੀਆਂ/ਮਿੰਟ
ਪ੍ਰੋ ਟੀਅਰ: 1,000 ਬੇਨਤੀਆਂ/ਮਿੰਟ
ਐਂਟਰਪ੍ਰਾਈਜ਼: ਕਸਟਮ ਹੱਦਾਂ
ਦਰ ਸੀਮਾ ਹੈਡਰ ਹਰ ਜਵਾਬ ਵਿੱਚ ਸ਼ਾਮਲ ਕੀਤੇ ਗਏ ਹਨ: X-RateLimit-Remaining