Portal modern untuk Pets API (Staging)
Satu halaman untuk dokumentasi endpoint, status layanan, contoh request, changelog, dan kontak support. Desain dibuat unik & rapi untuk kebutuhan staging/QA. Tidak ada form login/penyimpanan kredensial.
Quickstart
Contoh request aman untuk staging. Simpan token di server-side, jangan taruh di client/public repo.
# Health check
curl -s https://pets.api.staging.unitedpetclub.com/health
# List pets (example)
curl -s https://pets.api.staging.unitedpetclub.com/v1/pets \
-H "Authorization: Bearer YOUR_STAGING_TOKEN" \
-H "Accept: application/json"
# Create pet
curl -X POST https://pets.api.staging.unitedpetclub.com/v1/pets \
-H "Authorization: Bearer YOUR_STAGING_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name":"Mochi",
"species":"dog",
"breed":"shiba inu",
"birthdate":"2022-06-01",
"owner_ref":"user_10291"
}'
Endpoint path bisa kamu sesuaikan dengan rute asli service kamu.
Service Status
| Component | Status | Notes |
|---|---|---|
| API Gateway | Operational | Normal traffic |
| Pets Service | Operational | CRUD stable |
| Media Upload | Degraded | Slower processing window |
Status Endpoints (optional)
Jika kamu punya endpoint status internal, bisa ditaruh di sini:
GET /health
GET /status
GET /metrics (restricted)
Endpoints (Example Catalog)
| Method | Path | Description | Auth |
|---|---|---|---|
GET |
/health |
Service uptime & basic checks | Public |
GET |
/v1/pets |
List pets | Bearer |
POST |
/v1/pets |
Create pet profile | Bearer |
GET |
/v1/pets/{id} |
Get pet detail | Bearer |
PATCH |
/v1/pets/{id} |
Update pet profile | Bearer |
DELETE |
/v1/pets/{id} |
Remove pet record | Bearer |
Auth & Security
- Token-based S2S: gunakan Bearer token server-to-server.
- Staging isolation: data staging tidak boleh sinkron ke production tanpa pipeline resmi.
- Rate limit: rekomendasi 60 req/min per token (sesuaikan).
- Logging: simpan request-id untuk troubleshooting.
# Header standard
Authorization: Bearer YOUR_STAGING_TOKEN
Accept: application/json
Content-Type: application/json
Changelog
| Date | Version | Changes |
|---|---|---|
| 2026-02-14 | v1.3.0 | Added pet media metadata fields, improved validation errors. |
| 2026-02-01 | v1.2.4 | Stability fixes, faster list pagination in staging. |
| 2026-01-10 | v1.2.0 | Introduced PATCH update for pet profile. |
Ganti tanggal/versi sesuai release kamu.
Support & Contacts
Semua kontak disiapkan lengkap (ubah sesuai organisasi kamu):
Technical Support
Email: support@unitedpetclub.com
SLA: Mon–Fri 09:00–18:00
Ticket: support.unitedpetclub.com
Ops / On-Call (Urgent)
Email: ops@unitedpetclub.com
Phone: +1 (000) 000-0000
Escalation: 24/7
Business
Partnerships: partnerships@unitedpetclub.com
Legal: legal@unitedpetclub.com
Security: security@unitedpetclub.com
Legal & Policies
Jika halaman policy belum ada, sementara bisa diarahkan ke domain utama.