@extends('layouts.app') @section('title','API URLs - NGBVD') @section('content') @include('integrations.partials.settings_style') @php $base = url('/'); $endpoints = $endpoints ?? [ ['method'=>'GET','url'=>$base.'/api/v2/health','scope'=>'Public / health check','description'=>'Confirms that the API service is available.'], ['method'=>'GET','url'=>$base.'/api/v2/reference-data','scope'=>'reference_data.read','description'=>'Returns approved reference values for districts, incidents, gender, national status and related lookups.'], ['method'=>'GET','url'=>$base.'/api/v2/incidents/statistics','scope'=>'incident_statistics.read','description'=>'Returns corrected aggregate statistics with metadata and consistent disaggregation.'], ['method'=>'POST','url'=>$base.'/api/v2/incidents/push/ubos','scope'=>'ubos.push','description'=>'Pushes an approved case payload to the UBOS GBV Portal.'], ['method'=>'POST','url'=>$base.'/api/v2/cases/push/nsr','scope'=>'nsr.push','description'=>'Pushes a granular NGBVD case payload to the National Single Registry.'], ]; @endphp
API Reference

API URLs

Use these endpoints for approved integrations. Authenticated endpoints require X-Client-Key and X-Client-Secret headers.

Available Endpoints

Copy the endpoint URL and use the correct scope for the API client.

@foreach($endpoints as $endpoint)
{{ $endpoint['method'] ?? 'GET' }} Endpoint
{{ $endpoint['method'] ?? 'GET' }}
{{ $endpoint['url'] ?? '' }}

{{ $endpoint['description'] ?? '' }}

Scope: {{ $endpoint['scope'] ?? 'N/A' }}
@endforeach

Testing Headers

Use these headers in Postman or PowerShell.

Required Headers
Accept: application/json
X-Client-Key: YOUR_CLIENT_KEY
X-Client-Secret: YOUR_CLIENT_SECRET
Never share client secrets over email or screenshots. If exposed, disable the client and create a new one.
View Sharing Logs
@endsection