Authentication

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

Base URL

https://api.badges.ninja

Lahat ng API endpoint 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 (isang beses lang ito ipinapakita).

Mula sa API:

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

Paggamit ng Iyong 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

Gumagamit ang mga key ng prefix na bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Format ng Request

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

Istruktura 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

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

Mga Pampublikong Endpoint

May ilang endpoint na hindi nangangailangan ng authentication. Ito ang mga pampublikong verification endpoint sa ilalim ng /certify-badge/ na nagpapahintulot sa sinuman na i-verify ang mga badge credential.