CodeAtlas System API

openapi: 3.2.0
info:
  title: Codeatlas Com Br System API
  version: 1.0.0
  contact:
    name: CodeAtlas
    email: contato@codeatlas.com.br
    url: https://codeatlas.com.br/
  description: 'Operations tagged System across 2 of this provider''s published API definitions: codeatlas-com-br-openapi.json, codeatlas-com-br-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://codeatlas.com.br/api/v1
  description: Production API
- url: https://codeatlas.com.br/api/sandbox/v1
  description: 'Sandbox: fixture data, nothing is delivered or stored. Same paths and OAuth flow as production; request tokens with resource=https://codeatlas.com.br/api/sandbox/v1.'
security: []
tags:
- name: System
  description: Operational status endpoints.
paths:
  /health:
    get:
      operationId: getApiHealth
      summary: Check API availability
      description: Returns a public liveness response without exposing infrastructure details.
      tags:
      - System
      responses:
        '200':
          description: API is available.
          headers:
            Access-Control-Allow-Origin:
              description: Always *.
              schema:
                type: string
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '405':
          description: The HTTP method is not supported.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Allow:
              description: Supported methods.
              schema:
                type: string
        default:
          description: Unexpected error. Same shape as every other error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimited'
      security: []
    servers:
    - url: https://codeatlas.com.br/api/v1
      description: Production API
    - url: https://codeatlas.com.br/api/sandbox/v1
      description: 'Sandbox: fixture data, nothing is delivered or stored. Same paths and OAuth flow as production; request tokens with resource=https://codeatlas.com.br/api/sandbox/v1.'
components:
  headers:
    RateLimit:
      description: IETF draft-ietf-httpapi-ratelimit-headers. Remaining quota r and seconds until reset t for the named policy.
      schema:
        type: string
      example: '"read";r=119;t=45'
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
    XRateLimitLimit:
      description: Legacy. Requests allowed per window.
      schema:
        type: integer
    XRateLimitReset:
      description: Legacy. Seconds until the window resets.
      schema:
        type: integer
    XRateLimitRemaining:
      description: Legacy. Requests left in the window.
      schema:
        type: integer
    RateLimitPolicy:
      description: Quota q and window w in seconds of the policy that applies.
      schema:
        type: string
      example: '"read";q=120;w=60'
  responses:
    RateLimited:
      description: Rate limit exceeded. Wait Retry-After seconds.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - hint
          properties:
            code:
              type: string
              enum:
              - bad_request
              - conflict
              - forbidden
              - invalid_token
              - method_not_allowed
              - not_found
              - payload_too_large
              - rate_limited
              - unauthorized
              - unprocessable
              - unsupported_media_type
              description: Stable machine-readable code.
            message:
              type: string
              description: Human-readable description.
            hint:
              type: string
              description: How to fix the request.
          additionalProperties: false
      additionalProperties: false
      examples:
      - error:
          code: unauthorized
          message: This endpoint requires a Bearer access token.
          hint: 'Register a client at POST /oauth2/register, request a token at POST /oauth2/token and send it as Authorization: Bearer <token>.'
    HealthResponse:
      type: object
      required:
      - status
      - service
      - version
      properties:
        status:
          type: string
          const: ok
        service:
          type: string
          const: codeatlas-api
        version:
          type: string
      additionalProperties: false
  securitySchemes:
    oauth2ClientCredentials:
      type: oauth2
      description: OAuth 2.0 client_credentials. Register a client at POST /oauth2/register, then POST /oauth2/token. Tokens are JWTs valid for 3600 seconds. For the sandbox request a token with resource=https://codeatlas.com.br/api/sandbox/v1.
      flows:
        clientCredentials:
          tokenUrl: https://codeatlas.com.br/oauth2/token
          scopes:
            api:write: Create contact requests and exports.
externalDocs:
  description: Developer documentation
  url: https://codeatlas.com.br/docs
x-refined-from:
- codeatlas-com-br-openapi.json
- codeatlas-com-br-openapi.yml
x-sandbox:
  url: https://codeatlas.com.br/api/sandbox/v1
  description: Test mode for the whole API. Read endpoints return fixture services (sandbox-one, sandbox-two). POST /contact-requests is accepted and answers delivery=sandbox but is never emailed or stored. Exports and batch work on the fixtures. Sandbox and production tokens are not interchangeable.
  auth: Same OAuth client_credentials flow. Request tokens with resource=https://codeatlas.com.br/api/sandbox/v1.
  health: https://codeatlas.com.br/api/sandbox/v1/health
  documentation: https://codeatlas.com.br/auth.md