signdocs-com-br

signdocs-com-br Health API

Verificação de disponibilidade e histórico de saúde da API.

GitHub OpenAPI

Operations 2

GET /health Verificar saúde da API #
GET /health/history Consultar histórico de saúde #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/signdocs-com-br/openapi/signdocs-com-br-health-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/signdocs-com-br/json-schema/signdocs-com-br-advance-session-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signdocs-com-br/json-schema/signdocs-com-br-create-signing-session-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signdocs-com-br/json-schema/signdocs-com-br-step-complete-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signdocs-com-br/json-schema/signdocs-com-br-add-envelope-session-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signdocs-com-br/json-schema/signdocs-com-br-envelope-verification-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signdocs-com-br/json-schema/signdocs-com-br-advance-session-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/signdocs-com-br:signdocs-com-br-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

signdocs-com-br-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Signdocs Com Br Health API
  version: 1.4.0
  contact:
    name: SignDocs Brasil API Support
    email: suporte@signdocs.com.br
  license:
    name: Proprietary
    url: https://www.signdocs.com.br/termos-de-uso.html
  description: 'Operations tagged Health across 2 of this provider''s published API definitions: openapi.yaml, signdocs-com-br-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.signdocs.com.br
  description: Produção
- url: https://api-hml.signdocs.com.br
  description: Homologação
- url: https://mtls-api.signdocs.com.br
  description: Produção (mTLS)
- url: https://mtls-api-hml.signdocs.com.br
  description: Homologação (mTLS)
security:
- bearerJwt: []
tags:
- name: Health
  description: Verificação de disponibilidade e histórico de saúde da API.
paths:
  /health:
    get:
      operationId: checkHealth
      tags:
      - Health
      summary: Verificar saúde da API
      description: 'Retorna o status de saúde da API e de seus componentes internos (DynamoDB, S3, KMS, mTLS Truststore).

        Retorna `200` se todos os componentes estão operacionais, `503` se algum está indisponível.'
      security: []
      responses:
        '200':
          description: API saudável — todos os componentes operacionais.
          headers:
            Strict-Transport-Security:
              $ref: '#/components/headers/Strict-Transport-Security'
            X-Content-Type-Options:
              $ref: '#/components/headers/X-Content-Type-Options'
            X-Frame-Options:
              $ref: '#/components/headers/X-Frame-Options'
            Referrer-Policy:
              $ref: '#/components/headers/Referrer-Policy'
            Cache-Control:
              $ref: '#/components/headers/Cache-Control'
            API-Version:
              $ref: '#/components/headers/API-Version'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    servers:
    - url: https://api.signdocs.com.br
      description: Produção
    - url: https://api-hml.signdocs.com.br
      description: Homologação
    - url: https://mtls-api.signdocs.com.br
      description: Produção (mTLS)
    - url: https://mtls-api-hml.signdocs.com.br
      description: Homologação (mTLS)
  /health/history:
    get:
      operationId: getHealthHistory
      tags:
      - Health
      summary: Consultar histórico de saúde
      description: 'Retorna métricas históricas de disponibilidade da API, incluindo uptime por componente,

        incidentes e a última verificação realizada.'
      security: []
      parameters:
      - name: period
        in: query
        description: Período de consulta do histórico.
        schema:
          type: string
          enum:
          - 24h
          - 7d
          - 30d
          default: 24h
      responses:
        '200':
          description: Histórico de saúde retornado com sucesso.
          headers:
            Strict-Transport-Security:
              $ref: '#/components/headers/Strict-Transport-Security'
            X-Content-Type-Options:
              $ref: '#/components/headers/X-Content-Type-Options'
            X-Frame-Options:
              $ref: '#/components/headers/X-Frame-Options'
            Referrer-Policy:
              $ref: '#/components/headers/Referrer-Policy'
            Cache-Control:
              $ref: '#/components/headers/Cache-Control'
            API-Version:
              $ref: '#/components/headers/API-Version'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthHistoryResponse'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
    servers:
    - url: https://api.signdocs.com.br
      description: Produção
    - url: https://api-hml.signdocs.com.br
      description: Homologação
    - url: https://mtls-api.signdocs.com.br
      description: Produção (mTLS)
    - url: https://mtls-api-hml.signdocs.com.br
      description: Homologação (mTLS)
components:
  schemas:
    HealthResponse:
      type: object
      description: Resposta de verificação de saúde da API.
      required:
      - status
      - timestamp
      - service
      - components
      - latencyMs
      properties:
        status:
          type: string
          description: Status geral da API.
          enum:
          - healthy
          - unhealthy
        timestamp:
          type: string
          format: date-time
        service:
          type: string
          description: Nome do serviço.
          example: signdocs-external-api
        components:
          type: object
          description: Status individual de cada componente.
          properties:
            dynamodb:
              $ref: '#/components/schemas/ComponentHealth'
            s3:
              $ref: '#/components/schemas/ComponentHealth'
            kms:
              $ref: '#/components/schemas/ComponentHealth'
            mtlsTruststore:
              $ref: '#/components/schemas/ComponentHealth'
        latencyMs:
          type: number
          description: Latência total da verificação em milissegundos.
    ComponentHealth:
      type: object
      description: Status de saúde de um componente individual.
      required:
      - status
      - latencyMs
      properties:
        status:
          type: string
          description: Status operacional do componente.
          enum:
          - operational
          - down
        latencyMs:
          type: number
          description: Latência da verificação do componente em milissegundos.
    HealthHistoryResponse:
      type: object
      description: Resposta com histórico de saúde da API.
      required:
      - period
      - from
      - to
      - totalChecks
      - uptime
      - incidents
      properties:
        period:
          type: string
          description: Período consultado.
          enum:
          - 24h
          - 7d
          - 30d
        from:
          type: string
          format: date-time
          description: Início do período.
        to:
          type: string
          format: date-time
          description: Fim do período.
        totalChecks:
          type: integer
          description: Total de verificações no período.
        uptime:
          type: object
          description: Percentual de disponibilidade por componente.
          properties:
            overall:
              type: number
              description: Uptime geral (0-100).
              example: 99.95
            dynamodb:
              type: number
            s3:
              type: number
            kms:
              type: number
            mtlsTruststore:
              type: number
        incidents:
          type: array
          description: Incidentes no período.
          items:
            type: object
            required:
            - startedAt
            - affectedComponents
            properties:
              startedAt:
                type: string
                format: date-time
              endedAt:
                type: string
                format: date-time
              affectedComponents:
                type: array
                items:
                  type: string
              durationMinutes:
                type: number
        latestCheck:
          type: object
          description: Última verificação realizada.
          properties:
            overallStatus:
              type: string
            components:
              type: object
              properties:
                dynamodb:
                  $ref: '#/components/schemas/ComponentHealth'
                s3:
                  $ref: '#/components/schemas/ComponentHealth'
                kms:
                  $ref: '#/components/schemas/ComponentHealth'
                mtlsTruststore:
                  $ref: '#/components/schemas/ComponentHealth'
            checkedAt:
              type: string
              format: date-time
            totalLatencyMs:
              type: number
    ProblemDetail:
      type: object
      description: Formato de erro RFC 7807 Problem Details.
      required:
      - type
      - title
      - status
      properties:
        type:
          type: string
          format: uri
          description: URI que identifica o tipo de erro.
          example: https://api.signdocs.com.br/errors/bad-request
        title:
          type: string
          description: Resumo legível do tipo de erro.
          example: Bad Request
        status:
          type: integer
          description: Código de status HTTP.
          example: 400
        detail:
          type: string
          description: Explicação específica da ocorrência do erro.
          example: O campo 'purpose' é obrigatório.
        instance:
          type: string
          description: URI que identifica a ocorrência específica do erro (path da requisição).
          example: /v1/transactions
        code:
          type: string
          description: 'Código estável e legível por máquina para o caso específico, quando houver (ex.:

            `SIGNER_TURN`, `TIMESTAMP_UNAVAILABLE`). Prefira tratar o erro por `code` a interpretar `detail`.

            '
          example: TIMESTAMP_UNAVAILABLE
        retryable:
          type: boolean
          description: Presente quando a API afirma que reenviar a mesma requisição é seguro.
      additionalProperties: true
  headers:
    Cache-Control:
      description: Controle de cache.
      schema:
        type: string
        example: no-store
    API-Version:
      description: Versão da API.
      schema:
        type: string
        example: '1.0'
    X-Content-Type-Options:
      description: Prevenção de MIME sniffing.
      schema:
        type: string
        example: nosniff
    Referrer-Policy:
      description: Política de referrer.
      schema:
        type: string
        example: strict-origin-when-cross-origin
    Strict-Transport-Security:
      description: Política HSTS.
      schema:
        type: string
        example: max-age=31536000; includeSubDomains
    X-Frame-Options:
      description: Prevenção de clickjacking.
      schema:
        type: string
        example: DENY
  responses:
    TooManyRequests:
      description: Limite de requisições excedido.
      headers:
        Retry-After:
          description: Segundos a aguardar antes de tentar novamente.
          schema:
            type: integer
            example: 60
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: https://api.signdocs.com.br/errors/too-many-requests
            title: Too Many Requests
            status: 429
            detail: Rate limit exceeded
    ServiceUnavailable:
      description: Serviço temporariamente indisponível.
      headers:
        Retry-After:
          description: Segundos a aguardar antes de tentar novamente.
          schema:
            type: integer
            example: 5
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: https://api.signdocs.com.br/errors/service-unavailable
            title: Service Unavailable
            status: 503
            detail: A downstream service is temporarily unavailable. Please retry.
    InternalServerError:
      description: Erro interno do servidor.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: https://api.signdocs.com.br/errors/internal-server-error
            title: Internal Server Error
            status: 500
  securitySchemes:
    bearerJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token de acesso OAuth2 obtido via `POST /oauth2/token`.
    embedToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Token de sessão (clientSecret) retornado por `POST /v1/signing-sessions`.

        Usado pelos endpoints advance/get/resend-otp para autenticar a sessão.

        Contém claims: sub (sessionId), tenantId, transactionId, purpose: signing_session_embed.

        '
x-refined-from:
- openapi.yaml
- signdocs-com-br-openapi.yaml