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

# Obtener la credencial que llama

> Lee la credencial que llama: su organización, sus permisos, sus límites y las llamadas que puede hacer ahora. No cuenta para ningún límite.



## OpenAPI

````yaml /openapi/es.json get /api/v1/credential
openapi: 3.1.0
info:
  title: API de Ready for Commerce
  version: 1.0.0
  description: >-
    La referencia de cada operación de la API de Ready for Commerce. Todas las
    operaciones están en beta hasta el lanzamiento.
servers:
  - url: https://app.readyforcommerce.com
security:
  - apiKey: []
tags:
  - name: Credentials
    x-group: Credenciales
    description: >-
      La credencial que llama: su organización, sus permisos, sus límites y las
      llamadas que aún puede hacer.
  - name: Organization
    x-group: Organización
    description: 'Los ajustes de la organización: su nombre, su slug y su moneda.'
  - name: Billing
    x-group: Facturación
    description: >-
      La suscripción de la organización, la factura y el tope de cada módulo, y
      el uso del mes frente a su cuota gratuita.
  - name: Record types
    x-group: Tipos de registro
    description: >-
      Los tipos de registro que la credencial puede importar o exportar, con los
      campos y opciones de cada uno.
  - name: Imports
    x-group: Importaciones
    description: >-
      Para traer archivos CSV o Excel: subir o traer un archivo, inspeccionarlo
      y revisarlo, iniciar la importación y leer sus resultados.
  - name: Files
    x-group: Archivos
    description: El estado de un archivo subido, hasta que queda listo o rechazado.
  - name: Exports
    x-group: Exportaciones
    description: >-
      Para exportar a archivos CSV o Excel los registros que coinciden con un
      filtro; se guardan 14 días.
  - name: Export templates
    x-group: Plantillas de exportación
    description: >-
      Configuraciones de exportación guardadas con un nombre, para repetir la
      misma exportación.
  - name: Jobs
    x-group: Trabajos
    description: >-
      Las tareas largas corren como trabajos: su estado y su avance, sus
      mensajes, sus archivos para descargar o su cancelación.
  - name: Search
    x-group: Búsqueda
    description: >-
      Encuentra los registros de la organización por palabras, aunque lleven una
      errata, agrupados por tipo.
  - name: Version history
    x-group: Historial de versiones
    description: >-
      Las versiones de un registro, de la más nueva a la más antigua:
      compararlas y restaurar el registro a una de ellas.
  - name: Incidents
    x-group: Incidencias
    description: >-
      Los problemas de la organización que puedes ver: marcarlos como leídos o
      no leídos y resolverlos.
  - name: Notifications
    x-group: Notificaciones
    description: >-
      Tus notificaciones, de la más nueva a la más antigua: marcar una como
      leída o no leída, o todas como leídas.
  - name: Saved views
    x-group: Vistas guardadas
    description: >-
      La búsqueda, los filtros, el orden y las columnas de una tabla guardados
      con un nombre, tuyos o compartidos con la organización, y la vista con la
      que se abre cada tabla para ti.
  - name: Store connections
    x-group: Conexiones de tienda
    description: >-
      Las tiendas de la organización, conectadas con sus credenciales pegadas:
      listarlas, conectar una, reconectarla con credenciales nuevas o
      desconectarla.
  - name: Products
    x-group: Productos
    description: >-
      Los productos de la organización con sus opciones, variantes y precios:
      listarlos, leer uno, crear uno, cambiar el contenido, los precios o el
      estado de uno, duplicar uno como borrador, o eliminar uno.
paths:
  /api/v1/credential:
    get:
      tags:
        - Credentials
      summary: Obtener la credencial que llama
      description: >-
        Lee la credencial que llama: su organización, sus permisos, sus límites
        y las llamadas que puede hacer ahora. No cuenta para ningún límite.
      operationId: coreGetCredential
      responses:
        '200':
          description: Correcto
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        default:
          description: >-
            Un error, como `application/problem+json`: su `code` dice qué salió
            mal y `params` lleva sus valores
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Problem'
                  - properties:
                      code:
                        enum:
                          - core.bad_request
                          - core.invalid_credential
                          - core.forbidden
                          - core.module_not_enabled
                          - core.module_read_only
                          - core.not_found
                          - core.conflict
                          - core.org_deletion_scheduled
                          - core.payload_too_large
                          - core.unsupported_media_type
                          - core.validation_failed
                          - core.rate_limited
                          - core.surface_disabled
                          - core.internal
                          - core.unavailable
components:
  schemas:
    Credential:
      type: object
      properties:
        org:
          type: object
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
          required:
            - id
            - name
          additionalProperties: false
        type:
          type: string
          enum:
            - api_key
            - oauth_grant
        name:
          type: string
        display:
          type: string
        expiresAt:
          type: string
          format: date-time
        permissions:
          type: array
          items:
            type: string
        limits:
          type: object
          properties:
            read:
              type: integer
            write:
              type: integer
            bulk:
              type: integer
          required:
            - read
            - write
            - bulk
          additionalProperties: false
        remaining:
          type: object
          properties:
            read:
              type: integer
            write:
              type: integer
            bulk:
              type: integer
          required:
            - read
            - write
            - bulk
          additionalProperties: false
        notice:
          anyOf:
            - type: object
              properties:
                en:
                  type: string
                es:
                  type: string
              required:
                - en
                - es
              additionalProperties: false
            - type: 'null'
      required:
        - org
        - type
        - name
        - display
        - expiresAt
        - permissions
        - limits
        - remaining
        - notice
      additionalProperties: false
    Problem:
      type: object
      properties:
        type:
          type: string
          pattern: ^urn:rfc:problem:[\s\S]{0,}\.[\s\S]{0,}$
        status:
          type: integer
        title:
          type: string
        code:
          type: string
          pattern: ^[\s\S]{0,}\.[\s\S]{0,}$
        params:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        requestId:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              location:
                type: string
              pointer:
                type: string
              code:
                type: string
              params:
                type: object
                propertyNames:
                  type: string
                additionalProperties: {}
            required:
              - location
              - pointer
              - code
            additionalProperties: false
      required:
        - type
        - status
        - code
        - requestId
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Una llave de API de la organización, enviada en cada llamada como
        `Authorization: Bearer <llave>`. La crea una persona de la organización
        en la aplicación, en **Ajustes › API y conexiones › Llaves de API**.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.