Your Plan

Current Plan

API Requests

{{ number_format($school->api_requests_used) }} / {{ $school->plan === 'enterprise' ? '∞' : number_format($school->api_requests_limit) }}

Expires

@if ($school->plan === 'free') Never @elseif ($school->subscription_expires_at) {{ $school->subscription_expires_at->format('M d, Y') }} @else Not set @endif

Last Reset

{{ $school->api_requests_reset_at ? $school->api_requests_reset_at->format('M d, Y') : 'Never' }}

@if (!$school->isSubscriptionActive())

Subscription expired! The API will reject requests until the admin renews your plan.

@endif

To change your plan or renew your subscription, please contact the Super Admin.

API Key

@if ($school->api_key)

@else

No API key has been generated yet. Contact the Super Admin to generate one.

@endif

Note: Only the Super Admin can generate or reset your API key. When set, all chatbot requests must include the X-API-Key header.

API Endpoint

@if ($school->api_key) Send a POST request with your API key in the X-API-Key header. @else Send a POST request to the chatbot API. No API key required for this school. @endif

// POST request

POST {{ url('/api/chatbot') }}

// Headers

Content-Type: application/json

@if ($school->api_key)

X-API-Key: {{ $school->api_key }}

@endif

// Body

{

"message": "Is admission open?",

"school_code": "{{ $school->code }}"

}

Test with cURL:

curl -X POST
                            {{ url('/api/chatbot') }} -H "Content-Type:
                            application/json"{{ $school->api_key ? ' -H "X-API-Key: ' . $school->api_key . '"' : '' }}
                            -d '{"message": "hello", "school_code": "{{ $school->code }}"}'

Widget Embed Code

Copy and paste this code into your school's website, just before the closing </body> tag.

<!-- ShikshaLink Chatbot Widget -->
<script src="{{ url('/widget.js') }}"
        data-api="{{ url('/api') }}"
        data-school="{{ $school->code }}"{{ $school->api_key ? "\n        data-key=\"{$school->api_key}\"" : '' }}></script>

API & Integration

Your Plan

API Key

API Endpoint

Widget Embed Code