Authentication

Lahat ng API request sa badges.ninja ay nangangailangan ng authentication. Ipinapaliwanag ng pahinang ito kung paano i-authenticate ang inyong mga request.

Base URL

https://api.badges.ninja

Lahat ng API endpoints ay relative sa base URL na ito.

API Key Authentication

Ang pangunahing paraan ng authentication ay isang API key na ipinapasa sa X-Api-Key header.

Pagkuha ng API Key

Mula sa dashboard:

1. Mag-sign in sa badges.ninja.
2. Pumunta sa API Keys sa sidebar.
3. I-click ang Create API Key.
4. Kopyahin ang key (minsan lang ito ipinapakita).

Mula sa API:

Maaari ring pamahalaan ang mga API key sa pamamagitan ng API gamit ang inyong JWT token mula sa Cognito authentication flow. Tingnan ang dashboard para sa pinakasimpleng paraan.

Paggamit ng Inyong API Key

Isama ang X-Api-Key header sa bawat request:

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

Format ng API Key

Ang mga key ay gumagamit ng bws_ prefix:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Format ng Request

• Ang GET requests ay nagpapasa ng mga parameter bilang query strings
• Ang POST at PUT requests ay nagpapadala ng JSON body na may parameters object
• Lahat ng response ay nagre-return ng JSON na may Content-Type: application/json

Istraktura ng POST/PUT Request

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

Halimbawang Request

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

Halimbawang Response

{
  "statusCode": 200,
  "info": {
    "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
  }
}

Rate Limits

Ang mga API request ay napapailalim sa rate limiting. Kung lumagpas kayo sa limit, makakatanggap kayo ng 429 Too Many Requests response. Maghintay ng ilang segundo at subukan muli.

Mga Public Endpoint

May ilang endpoint na hindi nangangailangan ng authentication. Ito ay ang public verification endpoints sa ilalim ng /certify-badge/ na nagpapahintulot sa kahit sino na mag-verify ng badge credentials.