> ## Documentation Index
> Fetch the complete documentation index at: https://developer.sodacards.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ping

> Ping confirms a key works and reports which reseller and environment it
 authenticated as. It is the health check a developer hits first.



## OpenAPI

````yaml /api-reference/sodacards.yaml get /v1/ping
openapi: 3.1.0
info:
  title: SODACARDS Developer API
  description: Sell gift cards and game top-ups from your own systems.
  version: 1.0.0
servers:
  - url: https://api.sodacards.com
security:
  - ApiKeyAuth: []
tags:
  - name: PublicAPIService
    description: >-
      PublicAPIService is the public developer API a reseller calls with an API
      key.
       It is served as REST (via HTTP transcoding) so developers use GET /v1/... and
       curl, and its OpenAPI 3.1 spec is generated from this one file. Every method is
       authenticated by the API-key gateway that fronts it.
paths:
  /v1/ping:
    get:
      tags:
        - PublicAPIService
      summary: Ping
      description: |-
        Ping confirms a key works and reports which reseller and environment it
         authenticated as. It is the health check a developer hits first.
      operationId: PublicAPIService_Ping
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sodacards.devpublic.v1.PingResponse'
components:
  schemas:
    sodacards.devpublic.v1.PingResponse:
      type: object
      properties:
        status:
          type: string
          title: status
          description: status is "ok" when the key authenticated.
        environment:
          type: string
          title: environment
          description: >-
            environment is "live" or "test", so a developer sees which mode
            their key is
             in.
        resellerId:
          type: string
          title: reseller_id
          description: reseller_id is the account the key belongs to.
      title: PingResponse
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: Your API key, prefixed sc_live_ or sc_test_.
      name: X-API-Key
      in: header

````